Skip to main content

ListDistributionLinksResponse

result objectrequired
elements object[]required
  • Array [
  • contactIdContactId (string)
    Example: CGC_012345678901234
    linkstring<uri>
    linkExpirationstring<date-time>
    lastNamestring
    firstNamestring
    externalDataReferencestring
    emailstring
    phonestring
    unsubscribedboolean
    statusstring
    exceededContactFrequencyboolean
  • ]
  • nextPageNextPage (string)nullable

    Page number of result if response is divided across several pages. For the last page of results, the value returned is a URL.

    meta objectrequired

    Response metadata

    httpStatushttp status (string)required

    HTTP status code.

    requestIdAn identifier of the incoming request. (string)required

    Unique identifier of the associated request.

    noticeAn informational string about the request. (string)

    An informational string about the request.

    ListDistributionLinksResponse
    {
    "result": {
    "elements": [
    {
    "contactId": "CGC_012345678901234",
    "link": "string",
    "linkExpiration": "2024-07-29T15:51:28.071Z",
    "lastName": "string",
    "firstName": "string",
    "externalDataReference": "string",
    "email": "string",
    "phone": "string",
    "unsubscribed": true,
    "status": "string",
    "exceededContactFrequency": true
    }
    ],
    "nextPage": "string"
    },
    "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
    }
    }