Skip to main content

ListContactsInContactListResponse

result objectrequired
elements object[]required
  • Array [
  • contactIdContactId (string)required

    The ID of the contact.

    Example: CID_012345678901234
    firstNameFirstName (string)nullable

    The first name of the contact.

    lastNameLastName (string)nullable

    The last name of the contact.

    emailEmail (string)nullable

    The email of the contact.

    phonePhone (string)nullable

    The phone number of the contact.

    extRefExtRef (string)nullable

    The external reference for the contact.

    languageLanguage (string)nullable

    The language code for the contact.

    unsubscribedUnsubscribed (boolean)

    Indicates if the contact is unsubscribed.

    mailingListUnsubscribedMailingListUnsubscribed (boolean)

    Indicates if the contact is unsubscribed to the list.

    embeddedData objectnullable

    JSON object representing the embedded data fields to set for the contact

    property name*string
  • ]
  • nextPageNextPage (string)nullable
    meta objectrequired
    httpStatushttp status (string)required
    requestIdAn identifier of the incoming request. (string)required
    noticeAn informational string about the request. (string)
    ListContactsInContactListResponse
    {
    "result": {
    "elements": [
    {
    "contactId": "CID_012345678901234",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "extRef": "string",
    "language": "string",
    "unsubscribed": true,
    "mailingListUnsubscribed": true,
    "embeddedData": {}
    }
    ],
    "nextPage": "string"
    },
    "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
    }
    }