Skip to main content
POST
/
api
/
broadcasts.cancel
Cancel a broadcast
curl --request POST \
  --url https://{notifuseDomain}/api/broadcasts.cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workspace_id": "ws_1234567890",
  "id": "broadcast_12345"
}'
{
  "success": true
}

Authorizations

Authorization
string
header
required

API token for authentication

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

Broadcast cancelled successfully

success
boolean
Example:

true