Synup
Schlüssel erstellen
v1Ressourcen/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
Query-Parameter
idstringerforderlich
The campaign's id.
Antwort
dataobjectoptional
campaignIdstringoptional
The campaign.
canLaunchbooleanoptional
True when nothing blocks it.
blockersarray of objectoptional
Each blocker with a code and message.
warningsarray of stringoptional
Things that will not block it but are worth knowing.
recipientsobjectoptional
Counts of recipients and how many are reachable by email, phone or SMS consent. Null for a campaign that sends nothing.
Fehler
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}/readiness
Ihr API-Schlüssel
id *
{}

Anleitungen, die diese Ressource verwenden