Sign inGet Started

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

NameDescription
--nameName shown in the broadcast list (required; or in --body-file)
--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

Delivery

NameDescription
--sendSend on creation instead of leaving a draft, immediately or at --scheduled-at
--scheduled-atSchedule the send for a future time (RFC 3339, e.g. 2026-11-10T09:00:00Z); requires --send

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 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 updateUpdate a draft or scheduled WhatsApp broadcast
bird whatsapp broadcasts validateCheck whether a WhatsApp broadcast can send

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.