---
title: "Update broadcast status"
method: PATCH
path: "/whatsapp/broadcasts/{broadcast_id}"
tags: ["Broadcasts"]
---

# Update broadcast status

`PATCH /whatsapp/broadcasts/{broadcast_id}`

Update a broadcast status.

Set `status` to `stopped` to stop a broadcast that is currently sending. Pending recipients remain pending and no new sends are started.

Set `status` to `draft` to cancel a scheduled broadcast and clear its schedule.

## Request body

- WhatsappBroadcastUpdateRequest
  - `whatsapp_broadcast` object, required
    - `status` 'draft' | 'stopped', required — Set to `stopped` to stop a sending broadcast, or `draft` to cancel a scheduled broadcast.

## Response `200`

OK

- WhatsappBroadcastResponse
  - `data` WhatsappBroadcast, required
    - `id` string, uuid, required
    - `name` string, required — Campaign label
    - `status` 'draft' | 'scheduled' | 'sending' | 'stopped' | 'completed' | 'failed', required
    - `scheduled_at` string, date-time, nullable — When broadcast is scheduled to send
    - `started_at` string, date-time, nullable — When sending started
    - `stopped_at` string, date-time, nullable — When sending was stopped
    - `completed_at` string, date-time, nullable — When completed
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `sent_count` integer — Messages sent
    - `failed_count` integer — Failures
    - `delivered_count` integer — Delivered
    - `read_count` integer — Read
    - `pending_count` integer — Pending
    - `responded_count` integer — Responses
    - `response_rate` number, float — Response rate %
    - `total_recipients` integer, required — Total recipients
    - `phone_number_id` string, nullable — Phone number ID
    - `whatsapp_template` WhatsappBroadcastTemplate
      - `id` string, required — Meta template ID when available, otherwise internal UUID for legacy support
      - `meta_template_id` string, nullable — Meta's external template identifier
      - `name` string, required
      - `language_code` string, required
      - `category` string, required
      - `status` string, required
      - `components` object[] — Template component definitions (BODY, HEADER, BUTTON, etc.)

## Other responses

- `401` — Missing or invalid API key
- `404` — Resource not found
- `422` — Request validation failed

---

[API](https://skmtc.net/kapso/apis/kapso-platform-api.md) · [All operations](https://skmtc.net/kapso/apis/kapso-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kapso/kapso-platform-api/revisions/18ff5548a33f/schema)