v1Recursos/Review Invites/getCheck whether a campaign can launch
Check whether a campaign can launch
Says what launching a campaign would hit, without launching it: every blocker with a code, whether it can launch, the unsent recipients with an email, a phone or SMS consent, and warnings. It uses the same check as launching.
get
review-invite:read/api/v1/review-invites/campaigns/{id}/readinessParâmetros de consulta
idstringobrigatório
The campaign's id.
Resposta
dataobjectopcional
campaignIdstringopcional
The campaign.
canLaunchbooleanopcional
True when nothing blocks it.
blockersarray of objectopcional
Each blocker with a code and message.
warningsarray of stringopcional
Things that will not block it but are worth knowing.
recipientsobjectopcional
Counts of recipients and how many are reachable by email, phone or SMS consent. Null for a campaign that sends nothing.
Erros
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}/readiness
Sua chave de API
id *
{}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.