---
title: "Send a rendered broadcast test"
canonical: "https://bird.com/docs/api/reference/send-email-broadcast-test"
---

# Send a rendered broadcast test

`POST /v1/email/broadcasts/{broadcast_id}/test`

Supply the same changes, contact and fingerprint as a new preview to send the exact rendered content to an authorized current organization member with workspace access. Requires template read and emails write permission. Alternate-member and machine destinations also require members read. A change to template content, envelope fields, parameters or contact values returns E04089 (BroadcastPreviewChanged), a conflict_error. This does not send the campaign audience. A confirmed response replays unchanged for the same key and request within the configured idempotency window, with fresh authorization and member access checks. A replay sends no other test.

## Code samples

**TypeScript**

```ts
const params = {
  template: {
    parameters: {
      title: "Welcome",
      offer: "OCTOBER20",
      discount: 20,
      featured: false,
    },
  },
  contact_id: "con_01krdgeqcxet5s7t44vh8rt9mg",
};
const preview = await bird.broadcasts.preview(
  "eb_01krdgeqcxet5s7t44vh8rt9mg",
  params,
);
const accepted = await bird.broadcasts.test(
  "eb_01krdgeqcxet5s7t44vh8rt9mg",
  {
    ...params,
    to: "member@example.com",
    preview_fingerprint: preview.preview_fingerprint,
  },
  { idempotencyKey: "broadcast-preview-intent-1" },
);
console.log(accepted.id, accepted.status);
```

Examples: [TypeScript](/docs/api/reference/send-email-broadcast-test.ts.md) · [Python](/docs/api/reference/send-email-broadcast-test.py.md) · [Go](/docs/api/reference/send-email-broadcast-test.go.md) · [PHP](/docs/api/reference/send-email-broadcast-test.php.md) · [CLI](/docs/api/reference/send-email-broadcast-test.cli.md) · [MCP](/docs/api/reference/send-email-broadcast-test.mcp.md) · [cURL](/docs/api/reference/send-email-broadcast-test.curl.md)

## Example response `202`

```json
{
  "id": "em_01krdgeqcxet5s7t44vh8rt9mg",
  "from": {
    "email": "onboarding@messagebird.dev",
    "name": "Bird"
  },
  "to": [
    {
      "email": "delivered@messagebird.dev"
    }
  ],
  "subject": "Hello from Bird",
  "category": "marketing",
  "status": "accepted",
  "broadcast_id": "eb_01krdgeqcxet5s7t44vh8rt9mg",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "deferred_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": false,
  "track_clicks": false,
  "created_at": "2026-07-01T12:00:00Z"
}
```

## Path parameters

- `broadcast_id` (string): Broadcast identifier.

## Request body

- `template` (nullable object): Replaces the template, language or parameters for this request. Null removes the template for this request.
- `template.id` (string): Select this template. Changing the ID clears the old language, parameters and parameter overrides before supplied replacements. Repeating the same ID retains those values and clears the selected template version, so the next preparation uses the template's latest published version. Omit id to retain the selected template. Adding parameters to a draft created before parameters existed may clear its selected version so it uses the template's latest published version. To clear a draft's selection, set template itself to null.
- `template.language` (nullable string): The BCP-47 language tag that goes to the whole audience, such as `en` or `pt-BR`. It must be an exact match for a language on the template's published version, so `fr-CA` does not select `fr`. Leave it out to keep the language already selected. If you change the template `id` in the same request, the old language is cleared with the old template. Set this to `null` to use the published version's default language, unless the template has `language_source_required` set.
- `template.parameters` (object): Complete template input map. Each value is a string, number, boolean or null and is used exactly as given, so text containing braces or code-like syntax is never evaluated. Objects and lists are not accepted. Use bird.contact.first_name in the template for contact data. Names must be bare input names outside the bird namespace. Omission retains the map unless the template ID changes, which clears it; an empty object clears it, and null is invalid. The compact map is limited to 16384 UTF-8 bytes and 128 names. Individual email parameters keep their own format.
- `template.parameter_overrides` (object): Complete map of per-language parameter values, keyed by a BCP-47 language tag of at most 35 characters such as `es` or `pt-BR`. Each language holds only the names whose value differs for that language; a name it leaves out uses the value in `parameters`, including later changes to it. A value that is present always applies, even when it is `""`, `0`, `false`, `null` or equal to the `parameters` value. To return a name to the `parameters` value, send the map without it. Sending this map, even as `{}`, applies language rules to the broadcast: `parameters` must hold every input the default language's content, sender name, reply-to or headers use, and an input only the selected language uses may come from that language's entry instead. A broadcast that never sends it keeps the selected-language rules. Values for the default language, or for a language the broadcast does not send, are kept but not used. Omission retains the map unless the template ID changes, which clears it; an empty object removes every override, null is invalid and a language with no names is removed. Tags are stored in canonical BCP-47 form, so two spellings of one tag are refused. The compact map is limited to 16384 UTF-8 bytes, and `parameters` and every language together are limited to 128 distinct names.
- `from` (string or object): Replaces the sender for this request. Give it as a plain address, as `Jane <jane@acme.com>` to include a display name, or as an object with an address and a name.
  - Variant `Email string`: Email address, optionally in RFC 5322 mailbox form with an embedded display name.
  - Variant `object`: An email address with an optional display name.
    - `from.email` (string, required): Email address.
    - `from.name` (string): Display name shown alongside the address in mail clients.
- `reply_to` (nullable array): Replaces the reply-to addresses for this request. Null removes them.
- `headers` (object): Replaces the custom headers for this request rather than adding to them. Up to 25 of them, each value up to 998 characters. The header rules for updating a broadcast apply.
- `contact_id` (string): The workspace contact whose values fill `bird.contact.` inputs. Required when the template or envelope reads contact data. Present values are used as they are, and a property's fallback applies only when the contact has no value for it.
- `to` (string, required): The email address of a current organization member with access to this workspace.
- `preview_fingerprint` (string, required): The `preview_fingerprint` returned by the preview whose content you are sending.

## Response body

- `id` (string, required): Message ID.
- `from` (object, required): Sender address. `name` is present when a display name was provided on the send.
- `from.email` (string, required): Email address.
- `from.name` (string): Display name shown alongside the address in mail clients.
- `to` (array of object, required): Primary recipients. Length is the recipient count. Use the broadcasts endpoint for audience-targeted sends. Each entry's `name` is present when a display name was provided on the send.
- `to.email` (string, required): Email address.
- `to.name` (string): Display name shown alongside the address in mail clients.
- `cc` (array of object): CC recipients.
- `cc.email` (string, required): Email address.
- `cc.name` (string): Display name shown alongside the address in mail clients.
- `bcc` (array of object): BCC recipients.
- `bcc.email` (string, required): Email address.
- `bcc.name` (string): Display name shown alongside the address in mail clients.
- `subject` (string, required): The subject line as delivered. For a send that used a template, the stored subject is the template's, so this reports it with the send's `parameters` substituted in, which is what the recipient saw.
- `category` (string, required)

  Content classification, which controls suppression policy:

  - `marketing`: Blocks on all suppression reasons.
  - `transactional`: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail.

  Possible values: `marketing`, `transactional`
- `reply_to` (nullable array): Reply-To addresses, if set on the send. Empty/null when no Reply-To was provided.
- `status` (string, required)
- `accepted_count` (integer, required): How many recipients are in the `accepted` state, meaning we have the message and are getting ready to deliver it.
- `processed_count` (integer, required): How many recipients the message has been prepared for and queued for delivery.
- `delivered_count` (integer, required): How many recipients' messages were accepted by their mail server.
- `bounced_count` (integer, required): Number of recipients that resulted in a permanent delivery failure.
- `complained_count` (integer, required): Number of recipients that reported spam.
- `deferred_count` (integer, required): Number of recipients in transient delivery deferral. Their mail server asked for a retry, and delivery attempts continue.
- `rejected_count` (integer, required): Number of recipients rejected before delivery. Read the per-recipient `rejection_reason` field on `GET /v1/email/messages/{message_id}/recipients` for the specific cause.
- `processing_latency_ms` (nullable integer): Time between the send being accepted and the message being prepared for delivery, in milliseconds, for the fastest recipient. Null until the first recipient reaches `processed`.
- `delivery_latency_ms` (nullable integer): Time between the message being processed and the receiving mail server accepting it, in milliseconds, for the fastest delivered recipient. Null until the first recipient is delivered.
- `total_latency_ms` (nullable integer): End-to-end accept → delivered time for the fastest delivered recipient, in milliseconds. Null until the first recipient is delivered.
- `open_count` (integer, required): Total open events across all recipients.
- `click_count` (integer, required): Total click events across all recipients.
- `requested_language` (nullable string): The template language this send asked for, in canonical form (`pt-BR` for a request of `pt-br`). Null when the send named no language (it took the template's default) or used no template at all. Compare it with `resolved_language`: when they differ, the language you asked for was not available and the template's `on_missing_language` policy chose the one shown there instead.
- `resolved_language` (nullable string): The template language this send was actually delivered in, in canonical form. Null when the send used no template. A non-null value with a null `requested_language` means the send named no language and took the template's default.
- `template_id` (nullable string): The template this send rendered from, or null for a send that supplied its content inline.
- `template_version_id` (nullable string): The exact template version this send rendered from, or null for an inline send. A template's live version changes every time you submit it, so this is what identifies the wording that was actually delivered, together with `resolved_language`.
- `broadcast_id` (string): The broadcast that sent this message. Absent for a send that was not part of a broadcast. A broadcast records one message per recipient, and every one of them carries the same value here.
- `tags` (array of object): Labels on this message, each one a `name` and a `value`, that you can filter and search messages by. Use tags for anything you want to find messages by later, and `metadata` for data you only want handed back to you.
- `tags.name` (string, required): Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
- `tags.value` (string, required): Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
- `metadata` (object): Any JSON you kept on the message. We store it and hand it back in webhook payloads, and that is all it does. If you want to search or filter by it, use `tags` instead.
- `parameters` (nullable object): The substitution values this send supplied, whether inline or from a template, or null if none were supplied. They are the values applied to `subject` and to the bodies the content endpoint returns, kept so you can see what produced the delivered copy and not only the result.
- `attachments` (array of object): Attachment metadata for the send. Empty when no attachments were included. Raw content is not echoed. When content storage is enabled, download an attachment by its `id` via the message's attachment endpoint.
- `attachments.id` (string): Attachment ID, stable per email send.
- `attachments.filename` (string, required): Filename as shown to the recipient.
- `attachments.content_type` (string): Resolved MIME type at send time.
- `attachments.size` (integer, required): Decoded size in bytes.
- `attachments.inline` (boolean): True when the attachment was sent inline via a `content_id` reference in the HTML body, false for regular file attachments.
- `attachments.content_id` (nullable string): The Content-ID set at send time, when the attachment was inline.
- `track_opens` (boolean, required): Whether open tracking is enabled for this send.
- `track_clicks` (boolean, required): Whether click tracking is enabled for this send.
- `created_at` (string, required): When the send request was accepted.
- `thread_id` (nullable string): Thread this message belongs to, or null when the message is not part of one.
- `in_reply_to_message_id` (nullable string): The message this one is a reply to, if any.
- `delivered_at` (nullable string): When all recipients reached a terminal delivered state, or null if not yet fully delivered.
- `scheduled_at` (string): When this message is scheduled to send, for a send created with a future send time. Absent for an immediate send. Stays set after the scheduled send fires.

## 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)