broadcasts
Delete a broadcast
DELETE /v1/broadcasts/{id}
Auth required
api.broadcasts.manage
Permanently deletes a broadcast. The common use is cleaning up the draft
broadcasts you create only to test-send: a test send
(POST /v1/broadcasts/{id}/test) requires a persisted broadcast, so
iterating on content leaves drafts behind.
Refuses with 422 validation_failed while the broadcast is sending
or paused;
returns 404 not_found when the id is not a broadcast in this org.
DELETE is idempotent by HTTP semantics, so no Idempotency-Key is needed.
Path parameters
id string<uuid> required Resource UUID. An unparseable id reads as a clean 404 not_found.
Responses
Errors follow the RFC 7807 problem format — see the error reference.
204 Broadcast deleted
401 Missing, malformed, or unknown API key application/problem+json
403 Either the credential lacks the required scope (
code: invalid_scope), or it is bound to the test environment and this operation is irreversible (code: test_environment_forbidden). Branch on code: the first is fixed by granting the scope, the second only by using a live credential. See the "Live and test credentials" section of the API description. application/problem+json 404 Resource not found application/problem+json
422 A query parameter, path value or body field failed validation.
The body is a
validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json 429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json