Broadcasts

Cancel a broadcast

POST https://demo.notifuse.com/api/broadcasts.cancel

Cancels a broadcast that is scheduled, paused or sending, A/B test steps included (testing, test_completed and winner_selected). The emails still waiting in the queue are removed; the ones already sent stay sent. Any other status is refused.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body application/json

workspace_id string required

The ID of the workspace

  • Example: ws_1234567890
id string required

ID of the broadcast to cancel

  • Example: broadcast_12345

Response

200 Broadcast cancelled successfully object
success boolean
  • Example: true
400 Bad request - validation failed object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

404 Broadcast not found object
error string required

Error message

500 Internal server error object
error string required

Error message