Synup
Crear clave
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/api/v1/review-invites/campaigns/{id}/readiness
review-invite:read
Parámetros de consulta
idstringobligatorio
The campaign's id.
Respuesta
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.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/review-invites/campaigns/{id}/readiness
Su clave de API
id *
{}

Guías que usan este recurso