Cancel a broadcast
Cancel a scheduled, sending or paused broadcast, as Cancel does on the dashboard.
https://app.usenotix.dev/api/v1/broadcasts/{broadcastId}/cancelNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Cancel a scheduled, sending or paused broadcast, as Cancel does on the dashboard.
| Before | After | What it means |
|---|---|---|
SCHEDULED | DRAFT | Nothing went out. Change it and schedule it again. |
RUNNING or PAUSED | CANCELED | Nobody else is emailed. Emails already sent stay sent. It cannot be resumed; duplicate it to send it again. |
Any other broadcast answers 400. The answer's status says which it became.
Who can call it
A full access key, or a live AI key for a broadcast it created itself (any other answers 403 FORBIDDEN; pause it instead). A send-only or read-only key answers 403 SCOPE_DENIED. A key limited to one domain sees only broadcasts that send from its domain; any other answers 404.
Path parameters
Headers
Bearer followed by your API key.
Errors
The campaign is not scheduled, sending or paused, or it changed while it was being cancelled.
A live AI key cancelling a campaign it did not create.
No campaign with this id for the calling team (or, for a key limited to one domain, on its domain).
Every error has the same shape. See all error codes.
curl -X POST "https://app.usenotix.dev/api/v1/broadcasts/<broadcastId>/cancel" \
-H "Authorization: Bearer $NOTIX_API_KEY"
{
"success": true,
"status": "DRAFT"
}