---
title: "Update broadcast"
method: PATCH
path: "/v1/messaging/broadcasts/{broadcastId}"
tags: ["Broadcasts"]
---

# Update broadcast

`PATCH /v1/messaging/broadcasts/{broadcastId}`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/broadcasts/{broadcastId}`
- Auth: HTTP bearer

Update a broadcast's name, message, template, or segment filters. Only draft broadcasts can be updated.

**Billing:** Request; paid actions are priced in credits (see GET /v1/messaging/prices) · **Rate limit:** 60/min

## Path parameters

- `broadcastId` string, required

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `name` string
  - `message` object: Generic message payload (used for non-WhatsApp platforms).
    - `text` string
    - `messageTag` 'CONFIRMED_EVENT_UPDATE' | 'POST_PURCHASE_UPDATE' | 'ACCOUNT_UPDATE' | 'HUMAN_AGENT': Instagram and Facebook only. See createBroadcast.
    - `attachments` object[]: SMS only: sent as MMS media.
      - `url` string
      - `type` string
      - `filename` string
  - `template` object: WhatsApp template payload (used when platform is `whatsapp`).
    - `name` string
    - `language` string
    - `variableMapping` object: Maps template variable positions to contact fields. Keys are position strings ("1", "2"); values are { field, customValue }.
  - `description` string
  - `segmentFilters` object: Recipient segment filters (tags, channels, subscription state).

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `success` boolean
    - `broadcast` object
      - `id` string
      - `name` string
      - `status` string
      - `updatedAt` string, date-time
      - `description` string
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)