Launch a campaign
Starts sending a draft campaign, or a paused one again with the messages it had queued. This is the only route that makes a campaign send.
It first runs the checks GET /v1/campaigns/{campaignId}/readiness reports and refuses with the first that fails, as 422 and its code, such as campaign_has_no_steps or no_active_email_accounts. Enrolling the people on the campaign’s lists then runs in the background, so it answers 202: follow it with GET /v1/campaigns/{campaignId}. Launching a running campaign changes nothing. Launching a paused campaign may first write its older AI messages again, which can take a minute: allow two minutes.
Free. Scope: campaigns, with a key that can write.
Authorizations
Headers
Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.
1 - 255^[\x21-\x7E]+$