Skip to main content
POST
/
email
/
campaigns
/
{campaignId}
/
cancel
Cancel campaign
curl --request POST \
  --url https://www.dench.com/api/v1/email/campaigns/{campaignId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "campaignId": "ecmp_abc123",
  "status": "cancelled",
  "totalRecipients": 120,
  "queuedCount": 70,
  "sendingCount": 0,
  "sentCount": 50,
  "deliveredCount": 48,
  "openedCount": 12,
  "clickedCount": 3,
  "bouncedCount": 1,
  "complainedCount": 0,
  "failedCount": 0,
  "suppressedCount": 2,
  "unsubscribedCount": 0
}

Authorizations

​
Authorization
string
header
required

Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.

Path Parameters

​
campaignId
string
required

Response

Successful response

​
campaignId
string
required
​
status
enum<string>
required

Campaign lifecycle status.

Available options:
draft,
pending_approval,
scheduled,
sending,
paused,
completed,
cancelled,
failed
​
totalRecipients
number
required
​
queuedCount
number
required
​
sendingCount
number
required
​
sentCount
number
required
​
deliveredCount
number
required
​
openedCount
number
required
​
clickedCount
number
required
​
bouncedCount
number
required
​
complainedCount
number
required
​
failedCount
number
required
​
suppressedCount
number
required
​
unsubscribedCount
number
required