Synup
Create a key
v1Resources/Review Invites/getList a campaign's delivery outcomes

List a campaign's delivery outcomes

Lists each recipient's outcome — pending, skipped, sent, delivered, bounced, failed or unsubscribed — with the reason for a bounce or failure and whether the contact can be corrected. The counts cover the whole campaign.

get/api/v1/review-invites/campaigns/{id}/delivery
review-invite:read
Query parameters
idstringrequired
The campaign's id.
outcomestring (pending | skipped | sent | delivered | bounced | failed | unsubscribed)optional
Only recipients with this outcome.
pageintegeroptional
The page number, from 1.
perPageintegeroptional
Recipients per page.
Response
dataobjectoptional
recipientsarray of objectoptional
The recipients with their outcome.
totalintegeroptional
How many match.
pageintegeroptional
This page's number.
perPageintegeroptional
How many a page holds.
hasMorebooleanoptional
True when there is another page.
countsobjectoptional
How many recipients have each outcome, across the whole campaign.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/review-invites/campaigns/{id}/delivery
Your API key
id *
outcome
page
perPage
{}

Guides that use this resource