ListContactsInContactListResponse

result objectrequired

elements object[]required

Array [

contactIdContactId (string)required

The ID for the desired contact.

Example: CID_012345678901234

firstNameFirstName (string)nullable

Contact's first name

Possible values: <= 100 characters

lastNameLastName (string)nullable

Contact's last name

Possible values: <= 100 characters

emailEmail (string)nullable

Contact's email address. Must be in proper email format.

phonePhone (string)nullable

Contact's phone number

extRefExtRef (string)nullable

The external reference for the contact

languageLanguage (string)nullable

The language code to be used for the users account

unsubscribedUnsubscribed (boolean)

The contact's subscription status to this mailing list. If set to true, will opt the contact out of distributions for this mailing list. Defaults to false if not included.

mailingListUnsubscribedMailingListUnsubscribed (boolean)

Indicates whether the contact unsubscribed from this mailing list.

contactLookupIdContactLookupId (string)

Contact Mailing List ID

Example: CGC_012345678901234

embeddedData objectnullable

The embedded data object contains extra metadata that you want to associate with contacts. This user-defined data could include such data as birthplace, gender, employment status, etc. The values for embedded data can be provided to thisAPI as strings, booleans and numbers but not objects. However, the data will always be stored in the system as strings.

property name*anynullable

The embedded data object contains extra metadata that you want to associate with contacts. This user-defined data could include such data as birthplace, gender, employment status, etc. The values for embedded data can be provided to thisAPI as strings, booleans and numbers but not objects. However, the data will always be stored in the system as strings.

]

nextPageNextPage (string)nullable

meta objectrequired

httpStatushttp status (string)required

http status

requestIdAn identifier of the incoming request. (string)required

An identifier of the incoming request.

noticeAn informational string about the request. (string)

An informational string about the request.

ListContactsInContactListResponse

{
  "result": {
    "elements": [
      {
        "contactId": "CID_012345678901234",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "extRef": "string",
        "language": "string",
        "unsubscribed": true,
        "mailingListUnsubscribed": true,
        "contactLookupId": "CGC_012345678901234",
        "embeddedData": {}
      }
    ],
    "nextPage": "string"
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}