Cancel a scheduled broadcast

POST/api/v1/broadcasts/{id}/cancel

scope broadcasts:send

Returns a scheduled campaign to draft before it starts. A campaign that is already sending or finished returns 409 conflict.

Path parameters

Name	Type	Description
`id`required	`string (uuid)`	Broadcast id

Request

curl -X POST "https://your-crm.example.com/api/v1/broadcasts/a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d/cancel" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Response · 200 OK

{
  "data": {
    "id": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",
    "name": "September reminders",
    "kind": "template",
    "channel": "whatsapp",
    "template": {
      "name": "appointment_reminder",
      "language": "en_US"
    },
    "status": "draft",
    "scheduled_at": null,
    "counts": {
      "total": 240,
      "sent": 120,
      "delivered": 96,
      "read": 40,
      "replied": 3,
      "failed": 2
    },
    "created_at": "2026-09-02T10:00:00.000Z",
    "updated_at": "2026-09-02T10:02:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`name`required	`string`	Campaign name, as shown in the dashboard
`kind`required	`string (enum)`	template = an approved WhatsApp template; free_text = a personal-WhatsApp message`templatefree_text`
`channel`required	`string`	whatsapp \| personal_whatsapp
`template`required	`object \| null`	The template a template broadcast sends
`template.name`required	`string`
`template.language`required	`string`
`status`required	`string (enum)`	draft → scheduled → sending → sent \| failed`draftscheduledsendingsentfailed`
`scheduled_at`required	`string (date-time) \| null`	When it was (or will be) started
`counts`required	`object`	Live delivery counters — poll this endpoint for progress
`counts.total`required	`integer`	Recipients materialised
`counts.sent`required	`integer`	Handed to the channel
`counts.delivered`required	`integer`	Confirmed delivered to the handset
`counts.read`required	`integer`	Confirmed read
`counts.replied`required	`integer`	Recipients who replied
`counts.failed`required	`integer`	Rejected by the channel
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
404	`not_found`	No such resource in this account. A resource that exists in another account also returns this.
409	`conflict`	The request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.