Skip to main content

GetMailingListContactResponse

result objectrequired
contactIdContactId (string)

The ID for the desired contact.

Example: CID_012345678901234
creationDate objectnullable
oneOf
string
lastModified objectnullable
oneOf
string
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.

emailDomainEmailDomain (string)nullable
phonePhone (string)nullable

Contact's phone number

extRefExtRef (string)nullable

The external reference for the contact

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.

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.

anyOf
string<date-time>nullable
mailingListUnsubscribedMailingListUnsubscribed (boolean)

Indicates whether the contact unsubscribed from this mailing list.

mailingListUnsubscribeDate objectnullable

The date and time the contact unsubscribed.

anyOf
string<date-time>nullable
stats objectnullable
property name*stringnullable
contactLookupIdContactLookupId (string)

Contact Mailing List ID

Example: CGC_012345678901234
privateEmbeddedData 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.

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.

GetMailingListContactResponse
{
  "result": {
    "contactId": "CID_012345678901234",
    "creationDate": "string",
    "lastModified": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "emailDomain": "string",
    "phone": "string",
    "extRef": "string",
    "embeddedData": {},
    "language": "string",
    "directoryUnsubscribed": true,
    "directoryUnsubscribeDate": "2024-07-29T15:51:28.071Z",
    "mailingListUnsubscribed": true,
    "mailingListUnsubscribeDate": "2024-07-29T15:51:28.071Z",
    "stats": {},
    "contactLookupId": "CGC_012345678901234",
    "privateEmbeddedData": {}
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}