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

Authorizations

Bearer

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'

Path parameters

submissionIdstring · uuidRequired

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

404

Not Found

get

/api/v1/ReturnedZaps/{submissionId}

HTTPcURLJavaScriptPython

GET /api/v1/ReturnedZaps/{submissionId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "zapId": 1,
    "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": "2026-02-03T17:34:13.051Z"
  }
]