Skip to main content
CampaignsVersion: v3New

Cancel Email Campaign

POST/emails/locations/{locationId}/campaigns/emails/{campaignId}/cancel

Cancel a campaign that is scheduled, processing or paused. Pending sends, batch/drip sends, RSS schedules, A/B variations and any resend-to-unopened follow-up are stopped. Emails already sent are not recalled. A cancelled campaign can be edited and scheduled again with Schedule Campaign. Returns 409 for any other status.

Authorizations

Authorizationstringheaderrequired

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

Scope:emails/campaigns.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign ID returned by Create Email Campaign

Example:67f15c2ae99226d5bcccb8f3

Response

Success

campaignIdstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3
statusstringrequired

Campaign status after cancelling: always cancelled

Available optionsallsentfailedarchiveddraftprocessingscheduledcancelledpaused
Example:cancelled
traceIdstring

Trace ID of the request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4