Skip to main content
POST
Pause a campaign (idempotent; ?dryRun=true)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Transport-level replay protection — any v2 POST may send it (1–255 printable ASCII characters; UUIDs recommended). The first response for a key is recorded and replayed verbatim for retries with the same key + method/path/body for 24 hours; replayed responses carry the Idempotency-Replay: true response header. Reusing a key with a different request — or retrying while the original is still in flight — returns 409 IDEMPOTENCY_ERROR. 5xx responses are never recorded (the retry re-executes).

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

campaignId
string<uuid>
required

The campaign id (a first-class campaigns row).

Query Parameters

dryRun
boolean
default:false

Response

The transition result — or the dryRun report.

Result of a deterministic lifecycle transition (launch / send / pause / resume). Carries the transition facts in exactly one of launch / pause / resume depending on which transition ran.

object
string
required
Allowed value: "campaign"
id
string<uuid>
required
status
enum<string>
required
Available options:
draft,
active,
paused
launched
integer
required

Drafts scheduled by this transition (0 unless launching/resuming).

launch
object

Present on a launch/resume that scheduled work.

pause
object

Present on a pause.

resume
object

Present on a resume.