v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Campaigns

Pause a campaign (idempotent; ?dryRun=true)

Pauses the campaign. Idempotent — pausing an already-paused campaign is a no-op. ?dryRun=true returns { dryRun: true, campaignId, wouldPause } with no writes; a real pause returns the transition result carrying the pause facts.

post/campaigns/{campaignId}/pause

Query parameters

dryRunboolean

Headers

Idempotency-Keystring

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).

Response

The transition result — or the dryRun report.

OR