Skip to main content
DELETE
/
campaigns
/
{campaignId}
Delete a campaign (?confirm=true, ?dryRun=true)
curl --request DELETE \
  --url https://origami.chat/api/v2/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "confirmationRequired": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
campaignId
string<uuid>
required

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

Query Parameters

​
confirm
boolean
default:false

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

​
dryRun
boolean
default:false

Force the impact preview even when confirm is set.

Response

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

Impact preview returned by DELETE /campaigns/{campaignId} when ?confirm=true is absent (or ?dryRun=true is set). Nothing has been removed.

​
id
string<uuid>
required
​
name
string
required
​
confirmationRequired
boolean
required
​
status
enum<string>
required
Available options:
draft,
active,
paused