Show Source

• accountId(optional): string
  The account id in which the contact belongs. This is a read-only property.
• accountName(optional): string
  The account name in which the contact belongs.
• address1(optional): string
  The contact's first address.
• address2(optional): string
  The contact's second address.
• address3(optional): string
  The contact's third address.
• bouncebackDate(optional): string
  The contact's bounceback date.
• businessPhone(optional): string
  The contact's business phone number.
• city(optional): string
  The contact's city.
• country(optional): string
  The contact's country.
• createdAt(optional): string
  Read Only: true

  The date and time the contact was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the contact.
• currentStatus(optional): string
  The contact's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the contact.
• emailAddress(optional): string
  The contact's email address.
• emailFormatPreference(optional): string
  The contact's email format preference.
• fax(optional): string
  The contact's fax number.
• fieldValues(optional): array fieldValues
  Array containing type and id values for all of the contactFields associated with a given contact.
• firstName(optional): string
  The contact's first name.
• id(optional): string
  Read Only: true

  Id of the contact. This is a read-only property.
• isBounceback(optional): string
  Whether or not the contact has any associated bouncebacks.
• isSubscribed(optional): string
  Whether or not the contact is subscribed.
• lastName(optional): string
  The contact's last name.
• mobilePhone(optional): string
  The contact's mobile phone number.
• name(optional): string
  The name of the contact.
• permissions(optional): string
  The permissions for the contact granted to your current instance. This is a read-only property.
• postalCode(optional): string
  The contact's postal code.
• province(optional): string
  The contact's province.
• salesPerson(optional): string
  The contact's account representative.
• subscriptionDate(optional): string
  The contact's subscription date.
• title(optional): string
  The contact's title.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• unsubscriptionDate(optional): string
  The contact's unsubscription date.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the contact was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the contact.

{
    "title":"Contact",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the contact. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The contact's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the contact."
        },
        "description":{
            "type":"string",
            "description":"The description of the contact."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the contact granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the contact."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the contact."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the contact was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "firstName":{
            "type":"string",
            "description":"The contact's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The contact's last name."
        },
        "emailAddress":{
            "type":"string",
            "description":"The contact's email address."
        },
        "emailFormatPreference":{
            "type":"string",
            "description":"The contact's email format preference."
        },
        "isSubscribed":{
            "type":"string",
            "description":"Whether or not the contact is subscribed."
        },
        "isBounceback":{
            "type":"string",
            "description":"Whether or not the contact has any associated bouncebacks."
        },
        "accountName":{
            "type":"string",
            "description":"The account name in which the contact belongs."
        },
        "accountId":{
            "type":"string",
            "description":"The account id in which the contact belongs. This is a read-only property."
        },
        "title":{
            "type":"string",
            "description":"The contact's title."
        },
        "subscriptionDate":{
            "type":"string",
            "description":"The contact's subscription date."
        },
        "unsubscriptionDate":{
            "type":"string",
            "description":"The contact's unsubscription date."
        },
        "bouncebackDate":{
            "type":"string",
            "description":"The contact's bounceback date."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "address1":{
            "type":"string",
            "description":"The contact's first address."
        },
        "address2":{
            "type":"string",
            "description":"The contact's second address."
        },
        "address3":{
            "type":"string",
            "description":"The contact's third address."
        },
        "city":{
            "type":"string",
            "description":"The contact's city."
        },
        "province":{
            "type":"string",
            "description":"The contact's province."
        },
        "postalCode":{
            "type":"string",
            "description":"The contact's postal code."
        },
        "country":{
            "type":"string",
            "description":"The contact's country."
        },
        "businessPhone":{
            "type":"string",
            "description":"The contact's business phone number."
        },
        "mobilePhone":{
            "type":"string",
            "description":"The contact's mobile phone number."
        },
        "fax":{
            "type":"string",
            "description":"The contact's fax number."
        },
        "salesPerson":{
            "type":"string",
            "description":"The contact's account representative."
        }
    }
}

Show Source

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}