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. writeAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
locationIdstringrequired
Location ID
Example:
ve9EPM428h8vShlRW1KTcampaignIdstringrequired
Campaign ID returned by Create Email Campaign
Example:
67f15c2ae99226d5bcccb8f3Response
Success
campaignIdstringrequired
Campaign ID
Example:
67f15c2ae99226d5bcccb8f3statusstringrequired
Campaign status after cancelling: always cancelled
Available options
allsentfailedarchiveddraftprocessingscheduledcancelledpausedExample:
cancelledtraceIdstring
Trace ID of the request
Example:
019e4ef5-a65e-4198-8cf9-8e93dca9bda4