Skip to main content
POST
Archive Campaigns

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
campaignIds
string[]
required
Maximum array length: 50
Required string length: 1 - 160
action
enum<string>
required
Available options:
archive,
restore
organizationId
string

Required for session auth. Optional for an API key, which already identifies the organization.

Required string length: 1 - 120

Response

Aggregate result plus one result per campaign. success is true only when every requested campaign succeeds.

success
boolean
required

True only when every requested campaign succeeds.

campaignIds
string[]
required
succeededCount
integer
required
Required range: 0 <= x <= 9007199254740991
failedCount
integer
required
Required range: 0 <= x <= 9007199254740991
results
object[]
required