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. 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 the action
Available options
allsentfailedarchiveddraftprocessingscheduledcancelledpausedExample:
pausedtraceIdstring
Trace ID of the request
Example:
019e4ef5-a65e-4198-8cf9-8e93dca9bda4