v1Ressourcen/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
review-invite:read/api/v1/review-invites/campaigns/{id}/deliveryQuery-Parameter
idstringerforderlich
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.
Antwort
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.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites/campaigns/{id}/delivery
Ihr API-Schlüssel
id *
outcome
page
perPage
{}Anleitungen, die diese Ressource verwenden
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- Send a Review Invite via APIAdd a customer to a review-invite campaign with the Synup API once a visit completes, and the domain and number verification that gating requires.