Check readiness, launch and pause
Understand the effect of changing a live campaign.
Access: campaigns:read to validate; a workspace API key with campaigns:write to launch or pause.
Before launching
- Confirm the workspace and campaign ID.
- Review recipients, email content, sending accounts and schedule in Acquisity.
- Call Validate campaign readiness.
- If
readyis false, resolve every item infailures. Userulefor application logic andmessagefor the explanation.
Validation reads information only. A ready: true response does not guarantee launch will succeed: launch runs further checks, including sending-inbox readiness.
Launch or resume
Launching can spend money and send real email. The API request performs the action; this guide does not provide an enforced human-approval step.
When ready, call Launch campaign, then track its operation. Check the final result and campaign state before reporting success. HTTP 202 alone means the request was accepted, not that the campaign launched.
Pause
Call Pause campaign and track the operation. Pausing stops further sends as scheduling allows; messages already handed off for delivery may still go out.
An already-paused campaign can be paused again. For draft, completed and archived campaigns, the pause request is accepted, but the background operation finishes with status: "failed" and error.code: "conflict" because there is nothing to stop. Polling the operation still returns HTTP 200, so check its status and error fields rather than expecting an immediate HTTP 409. A paused campaign stays paused until explicitly resumed through launch.