PageOfContacts
result objectrequired
elements object[]required
Array [
contactIdContactId (string)required
The ID for the desired contact.
Example:
CID_012345678901234firstNameFirstName (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
directoryUnsubscribedDirectoryUnsubscribed (boolean)
Indicates whether the contact unsubscribed from all contact from the Directory.
directoryUnsubscribeDate objectnullable
The date and time the contact unsubscribed.
- string<date-time>
- integer<int64>
string<date-time>nullable
mailingListUnsubscribedMailingListUnsubscribed (boolean)
Indicates whether the contact unsubscribed from this mailing list.
mailingListUnsubscribeDate objectnullable
The date and time the contact unsubscribed.
- string<date-time>
- integer<int64>
string<date-time>nullable
]
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.
PageOfContacts
{
"result": {
"elements": [
{
"contactId": "CID_012345678901234",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"extRef": "string",
"language": "string",
"directoryUnsubscribed": true,
"directoryUnsubscribeDate": "2024-07-29T15:51:28.071Z",
"mailingListUnsubscribed": true,
"mailingListUnsubscribeDate": "2024-07-29T15:51:28.071Z"
}
],
"nextPage": "string"
},
"meta": {
"httpStatus": "string",
"requestId": "string",
"notice": "string"
}
}