Broadcasts

Send a scheduled broadcast back to draft

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

Sends a scheduled broadcast back to draft before it starts sending. It keeps its date, time and timezone, can be edited, and can be scheduled again; it will not be sent at its scheduled time.

Once the sending has started (emails queued or sent, or its send task under way), the request is refused with 400: cancel the broadcast instead. A scheduled broadcast shows as sending once its sending starts, and can then be paused. Not available in demo mode.

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 scheduled broadcast to send back to draft

  • Example: broadcast_12345

Response

200 Broadcast sent back to draft object
success boolean
  • Example: true
400 The broadcast is not scheduled, or its sending has started (cancel it instead) object
error string required

Error message

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

Error message

403 Forbidden - write access to broadcasts required 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