ReturnedZaps

Returned ZAPs are mailings that were successfully sent but returned because the carrier couldn't physically deliver them for some reason. We will log any ZAPs returned as well as the reason they weren't delivered if the carrier provides one. This information can be retrived on a submission level via the following endpoint.

GET/api/v1/ReturnedZaps/{submissionId}
Path parameters
submissionId*string (uuid)
Response

Success

Body
idinteger (int64)
zapIdinteger (int64)
zapIdentifierstring (uuid)
campaignIdstring (uuid)
apiConsumerIdnullable string (uuid)
clientIdstring (uuid)
submissionIdstring (uuid)
returnReasonnullable string
returnedDatestring (date-time)
Request
const response = await fetch('/api/v1/ReturnedZaps/{submissionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "zapIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "apiConsumerId": "123e4567-e89b-12d3-a456-426614174000",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "submissionId": "123e4567-e89b-12d3-a456-426614174000",
    "returnReason": "text",
    "returnedDate": "2024-06-19T20:55:47.454Z"
  }
]

Last updated