Skip to main content
CampaignsVersion: v3New

Archive Email Campaign

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

Archive this campaign. Repeated requests return archived=true without toggling the state. This changes visibility; it does not cancel sending.

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

Example:67f15c2ae99226d5bcccb8f3

Response

Success

idstringrequired

Campaign ID in the authorized location.

Example:67f15c2ae99226d5bcccb8f3
archivedbooleanrequired

Resulting archive state. Repeating the same operation leaves this state unchanged.

Example:true