Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Cancel a broadcast that still has messages to send.
broadcast.canceled event follows.
broadcasts:write scope.| Field | Type | Required | Notes |
|---|---|---|---|
broadcast_id | string | Yes | The broadcast’s id. |
curl -X POST "https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33/cancel" \
-H "Authorization: Bearer $OMNI_API_KEY"
import os
import requests
response = requests.post(
"https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33/cancel",
headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())
const response = await fetch("https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33/cancel", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.OMNI_API_KEY}` },
});
console.log(response.status, await response.json());
200 OK — the broadcast, now canceled.
{
"id": "7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33",
"name": "Diwali offer",
"channel": "whatsapp",
"status": "canceled",
"purpose": "marketing",
"recipients": 1840,
"counts": {
"skipped": 12,
"sent": 1204,
"delivered": 1179,
"failed": 9,
"waiting": 624
},
"percent": 66,
"error": "Cancelled before every message was sent.",
"scheduled_for": null,
"created": "2026-10-06T09:12:04+05:30",
"started": "2026-10-06T09:12:31+05:30",
"finished": "2026-10-06T09:20:44+05:30"
}
{"error": {"code", "message", "field"}}; field is there when one input is at fault.
| Status | Error code | When |
|---|---|---|
| 409 | invalid_state | A broadcast that has finished can’t be canceled. message says why. |
| 404 | not_found | No broadcast of this account’s has that id. |
| 403 | scope_missing | The key doesn’t have the broadcasts:write scope. |
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.