---
title: "bird whatsapp broadcasts preview"
description: "Render a WhatsApp broadcast's message"
canonical: "https://bird.com/docs/cli/reference/whatsapp-broadcasts-preview"
---

# `bird whatsapp broadcasts preview`

## Usage

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

## Description

Render a WhatsApp broadcast's message

Nothing is sent or saved. Keep preview\_fingerprint for "bird whatsapp broadcasts test".

Build the request from the &lt;broadcast\_id> argument and flags, a JSON WhatsAppBroadcastPreviewRequest body via
--body-file ("-" reads stdin), or both — an inline value 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.

## Procedure

Step 6 of 8 of "Check, test and send a WhatsApp broadcast". Previous: bird whatsapp broadcasts pricing-estimate. Next: bird whatsapp broadcasts test.

## Examples

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

# the body it prints:
```

```json
{
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "template": {
    "language": "es",
    "parameters": {
      "header_url": "https://cdn.example.com/fall.jpg",
      "promo_code": "FALL26"
    }
  }
}
```

## Options

#### 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` | Accepted for this POST request. Each call computes a fresh result; reusing the key does not replay an earlier result. |

#### Options

| Name                | Description                                                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--language`        | Override the 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 |
| `--parameters`      | Override the parameters. Template inputs as one JSON object, such as {"promo\_code":"FALL25"}; replaces the whole map                                |
| `--contact-id`      | Contact whose data fills the template; required when it reads contact data                                                                           |
| `--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 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 update`](/docs/cli/reference/whatsapp-broadcasts-update)                     | Update a draft or scheduled WhatsApp broadcast              |
| [`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)