Skip to main content
POST
Archive Campaign
Archiving stops sending: a running campaign is paused, then archived, so the response reads "state": "paused". An archived campaign cannot be started. Unarchive it first. List archived campaigns with status=archived on Get Many Campaigns. Archiving a campaign that is already archived changes nothing and answers 200.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId
string
required

The unique identifier of the campaign

Response

Success

_id
string
archived
boolean

true once the campaign is archived

state
string

The campaign state. Archiving pauses a running campaign, so it reads paused. Absent on a campaign that has none yet