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
Path parameters
submissionIdstring · uuidRequired
Responses
200
Success
application/json
400
Bad Request
401
Unauthorized
404
Not Found
get
GET /api/v1/ReturnedZaps/{submissionId} HTTP/1.1
Host:
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": "2025-07-04T01:14:40.036Z"
}
]
Last updated