Synup
Créer une clé
v1Ressources/Invitations à laisser un avis/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
Paramètres de requête
idstringobligatoire
The campaign's id.
Réponse
dataobjectfacultatif
campaignIdstringfacultatif
The campaign.
canLaunchbooleanfacultatif
True when nothing blocks it.
blockersarray of objectfacultatif
Each blocker with a code and message.
warningsarray of stringfacultatif
Things that will not block it but are worth knowing.
recipientsobjectfacultatif
Counts of recipients and how many are reachable by email, phone or SMS consent. Null for a campaign that sends nothing.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/review-invites/campaigns/{id}/readiness
Votre clé API
id *
{}

Guides qui utilisent cette ressource