Sign in

v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Campaigns

Delete a campaign (?confirm=true, ?dryRun=true)

Soft-deletes the campaign (instantly halting its picker) and cancels its orphaned sequences. Follows the v2 deletes convention:

  • Without ?confirm=true (or with ?dryRun=true) → HTTP 200 with the impact preview { id, name, confirmationRequired: true, status }; nothing removed.
  • With ?confirm=true → deletes and returns { id, name, deleted: true }.
delete/campaigns/{campaignId}

Query parameters

confirmboolean

Must be true to actually delete. Omit for the impact preview.

dryRunboolean

Force the impact preview even when confirm is set.

Response

The impact preview (unconfirmed / dryRun) or the delete receipt (confirmed).

OR