Archive a campaign

POST 
/broadcasts/:id/archive

Takes the campaign off the main list (or brings it back, with archived: false). A campaign in progress must be cancelled or finish first.

Request

Responses

200

Record found.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

402

No entitlement (payment_required). The body carries the reason in reason and the way out in action: what to do (kind) and the dashboard page where it is done (url).

404

Resource does not exist (not_found).

409

The campaign is not in a state that allows the action (broadcast_invalid_state, with status).

429

Rate limit exceeded (rate_limit).

Response Headers

Retry-After

Seconds to wait before retrying.

X-RateLimit-Category

Which rate limit category applied — send, media or default.

X-RateLimit-Scope

Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).

X-RateLimit-Limit

Request ceiling for this category in the current window.

X-RateLimit-Remaining

Requests left in the current window.