bird whatsapp broadcasts create
Usage
Codevoorbeeld
bird whatsapp broadcasts create [flags]Description
Create a WhatsApp broadcast
Only --name is required; fill in the rest later with "bird whatsapp broadcasts update". Pass --send to send on creation instead of leaving a draft; a send also needs --from, --audience-id and --template. With --send, pass --idempotency-key and reuse it on a retry, or a retry creates and sends a second broadcast.
Build the request from flags, a JSON WhatsAppBroadcastCreateRequest 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
Codevoorbeeld
# print the body shape (no credentials needed)
bird whatsapp broadcasts create --example
# the body it prints:Codevoorbeeld
{
"audience_id": "adn_01krdgeqcxet5s7t44vh8rt9mg",
"from": "+13124495648",
"name": "Fall launch",
"tags": [
{
"name": "campaign",
"value": "fall"
}
],
"template": {
"id": "wat_01ky4x8e4genzb7way45txfkm1",
"language": "en-US"
}
}Options
Content
| Name | Description |
|---|---|
--name | Name shown in the broadcast list (required; or in --body-file) |
--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 |
Delivery
| Name | Description |
|---|---|
--send | Send on creation instead of leaving a draft, immediately or at --scheduled-at |
--scheduled-at | Schedule the send for a future time (RFC 3339, e.g. 2026-11-10T09:00:00Z); requires --send |
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 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 update | Update a draft or scheduled WhatsApp broadcast |
bird whatsapp broadcasts validate | Check whether a WhatsApp broadcast can send |
Gerelateerde bronnen
Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.