v1Recursos/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}/deliveryParâmetros de consulta
idstringobrigatório
The campaign's id.
outcomestring (pending | skipped | sent | delivered | bounced | failed | unsubscribed)opcional
Only recipients with this outcome.
pageintegeropcional
The page number, from 1.
perPageintegeropcional
Recipients per page.
Resposta
dataobjectopcional
recipientsarray of objectopcional
The recipients with their outcome.
totalintegeropcional
How many match.
pageintegeropcional
This page's number.
perPageintegeropcional
How many a page holds.
hasMorebooleanopcional
True when there is another page.
countsobjectopcional
How many recipients have each outcome, across the whole campaign.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/review-invites/campaigns/{id}/delivery
Sua chave de API
id *
outcome
page
perPage
{}Guias que usam este recurso
- 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.