Cancel a campaign
POST/broadcasts/:id/cancel
Stops the campaign for good. Whoever has not received it yet is marked skipped, with the reason canceled.
Request
Responses
- 200
- 401
- 402
- 404
- 409
- 429
Record found.
Missing, malformed, unknown or revoked token (authentication), or a suspended
account (tenant_inactive).
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).
Resource does not exist (not_found).
The campaign is not in a state that allows the action (broadcast_invalid_state, with status).
Rate limit exceeded (rate_limit).
Response Headers
Seconds to wait before retrying.
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.