---
title: "bird whatsapp broadcasts update"
description: "Update a draft or scheduled WhatsApp broadcast"
canonical: "https://bird.com/docs/cli/reference/whatsapp-broadcasts-update"
---

# `bird whatsapp broadcasts update`

## Usage

```bash
bird whatsapp broadcasts update <broadcast-id> [flags]
```

## Description

Update a draft or scheduled WhatsApp broadcast

Only the fields you pass change, except the template: it is replaced as a whole, including its
parameters, so pass --template with the other template flags. A broadcast that is already sending can no
longer be edited. To clear from, audience\_id or template, pass an explicit null in --body-file.

Build the request from flags, a JSON WhatsAppBroadcastUpdateRequest body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

## Examples

```bash
# print the body shape (no credentials needed)
bird whatsapp broadcasts update --example

# the body it prints:
```

```json
{
  "template": {
    "id": "wat_01ky4x8e4genzb7way45txfkm1",
    "language": "es"
  }
}
```

```bash
# clear the template (a null only reaches the wire through --body-file)
echo '{"template": null}' | bird whatsapp broadcasts update <broadcast-id> --body-file -
```

## Options

#### Content

| Name               | Description                                                                                                                                     |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `--name`           | Name shown in the broadcast list                                                                                                                |
| `--from`           | Connected WhatsApp number to send from, in E.164 format                                                                                         |
| `--audience-id`    | Audience to send to                                                                                                                             |
| `--template`       | WhatsApp template ID (wat\_…) to send                                                                                                           |
| `--language`       | One of the template's languages, such as en-US. Omit it to choose each recipient's language from their phone number's country. Needs --template |
| `--parameters`     | Template inputs as one JSON object, such as {"promo\_code":"FALL25"}; replaces the whole map                                                    |
| `--bid-multiplier` | Scale the language's maximum price for this broadcast, from 0.01 to 100 (default 1)                                                             |

#### Labels & metadata

| Name                | Description                                                    |
| ------------------- | -------------------------------------------------------------- |
| `--tag <key=value>` | Tag as name=value; repeatable. Replaces the existing tags      |
| `--metadata`        | Arbitrary JSON metadata object. Replaces the existing metadata |

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Options

| Name                | Description                                      |
| ------------------- | ------------------------------------------------ |
| `--response-schema` | Print the fields this command returns, then exit |

## Related

| Name                                                                                                    | Description                                                 |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [`bird whatsapp broadcasts cancel`](/docs/cli/reference/whatsapp-broadcasts-cancel)                     | Cancel a WhatsApp broadcast                                 |
| [`bird whatsapp broadcasts counts`](/docs/cli/reference/whatsapp-broadcasts-counts)                     | Get a WhatsApp broadcast's audience counts                  |
| [`bird whatsapp broadcasts create`](/docs/cli/reference/whatsapp-broadcasts-create)                     | Create a WhatsApp broadcast                                 |
| [`bird whatsapp broadcasts delete`](/docs/cli/reference/whatsapp-broadcasts-delete)                     | Delete a WhatsApp broadcast                                 |
| [`bird whatsapp broadcasts get`](/docs/cli/reference/whatsapp-broadcasts-get)                           | Get a WhatsApp broadcast                                    |
| [`bird whatsapp broadcasts list`](/docs/cli/reference/whatsapp-broadcasts-list)                         | List WhatsApp broadcasts                                    |
| [`bird whatsapp broadcasts list-recipients`](/docs/cli/reference/whatsapp-broadcasts-list-recipients)   | List recipients of a WhatsApp broadcast                     |
| [`bird whatsapp broadcasts preview`](/docs/cli/reference/whatsapp-broadcasts-preview)                   | Render a WhatsApp broadcast's message                       |
| [`bird whatsapp broadcasts pricing-estimate`](/docs/cli/reference/whatsapp-broadcasts-pricing-estimate) | Estimate the cost of a WhatsApp broadcast                   |
| [`bird whatsapp broadcasts send`](/docs/cli/reference/whatsapp-broadcasts-send)                         | Send a WhatsApp broadcast                                   |
| [`bird whatsapp broadcasts send-quota`](/docs/cli/reference/whatsapp-broadcasts-send-quota)             | Get the messaging limit for a WhatsApp broadcast            |
| [`bird whatsapp broadcasts test`](/docs/cli/reference/whatsapp-broadcasts-test)                         | Send a WhatsApp broadcast's previewed message to one number |
| [`bird whatsapp broadcasts validate`](/docs/cli/reference/whatsapp-broadcasts-validate)                 | Check whether a WhatsApp broadcast can send                 |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)