Synup
Create a key
v1Resources/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 parameters
idstringrequired
The campaign's id.
Response
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.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/review-invites/campaigns/{id}/readiness
Your API key
id *
{}

Guides that use this resource