Skip to main content
CampaignsVersion: v3New

Pause Email Campaign

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

Pause a campaign that is scheduled or processing (including batch/drip sends, RSS schedules and A/B tests). Sending stops until Resume Email Campaign is called. While paused you can edit content with Update Email Campaign, then call Resume Email Campaign or Schedule Campaign to reschedule with new settings. 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 the action

Available optionsallsentfailedarchiveddraftprocessingscheduledcancelledpaused
Example:paused
traceIdstring

Trace ID of the request

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