bird whatsapp broadcasts update
Usage
Code example
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
Code example
# print the body shape (no credentials needed)
bird whatsapp broadcasts update --example
# the body it prints:Code example
{
"template": {
"id": "wat_01ky4x8e4genzb7way45txfkm1",
"language": "es"
}
}Code example
# 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 | Cancel a WhatsApp broadcast |
bird whatsapp broadcasts counts | Get a WhatsApp broadcast's audience counts |
bird whatsapp broadcasts create | Create a WhatsApp broadcast |
bird whatsapp broadcasts delete | Delete a WhatsApp broadcast |
bird whatsapp broadcasts get | Get a WhatsApp broadcast |
bird whatsapp broadcasts list | List WhatsApp broadcasts |
bird whatsapp broadcasts list-recipients | List recipients of a WhatsApp broadcast |
bird whatsapp broadcasts preview | Render a WhatsApp broadcast's message |
bird whatsapp broadcasts pricing-estimate | Estimate the cost of a WhatsApp broadcast |
bird whatsapp broadcasts send | Send a WhatsApp broadcast |
bird whatsapp broadcasts send-quota | Get the messaging limit for a WhatsApp broadcast |
bird whatsapp broadcasts test | Send a WhatsApp broadcast's previewed message to one number |
bird whatsapp broadcasts validate | Check whether a WhatsApp broadcast can send |
Related resources
Continue with the documentation, guides and examples for this topic.