Sign inGet Started

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

NameDescription
--nameName shown in the broadcast list
--fromConnected WhatsApp number to send from, in E.164 format
--audience-idAudience to send to
--templateWhatsApp template ID (wat_…) to send
--languageOne 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
--parametersTemplate inputs as one JSON object, such as {"promo_code":"FALL25"}; replaces the whole map
--bid-multiplierScale the language's maximum price for this broadcast, from 0.01 to 100 (default 1)

Labels & metadata

NameDescription
--tag <key=value>Tag as name=value; repeatable. Replaces the existing tags
--metadataArbitrary JSON metadata object. Replaces the existing metadata

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp broadcasts cancelCancel a WhatsApp broadcast
bird whatsapp broadcasts countsGet a WhatsApp broadcast's audience counts
bird whatsapp broadcasts createCreate a WhatsApp broadcast
bird whatsapp broadcasts deleteDelete a WhatsApp broadcast
bird whatsapp broadcasts getGet a WhatsApp broadcast
bird whatsapp broadcasts listList WhatsApp broadcasts
bird whatsapp broadcasts list-recipientsList recipients of a WhatsApp broadcast
bird whatsapp broadcasts previewRender a WhatsApp broadcast's message
bird whatsapp broadcasts pricing-estimateEstimate the cost of a WhatsApp broadcast
bird whatsapp broadcasts sendSend a WhatsApp broadcast
bird whatsapp broadcasts send-quotaGet the messaging limit for a WhatsApp broadcast
bird whatsapp broadcasts testSend a WhatsApp broadcast's previewed message to one number
bird whatsapp broadcasts validateCheck whether a WhatsApp broadcast can send

Continue with the documentation, guides and examples for this topic.