bird email broadcasts test
Usage
Code example
bird email broadcasts test <broadcast-id> [flags]Description
test a broadcast
Send the fresh preview content to an authorized current organization member with workspace access. This sends an external email. Requires template read and emails write permission; alternate-member and machine destinations also require members read.
Build the request from the <broadcast_id> argument and flags, a JSON EmailBroadcastTestRequest 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 5 of 5 of "Preview and test a broadcast". Previous: bird email broadcasts preview.
Examples
Code example
# print the body shape (no credentials needed)
bird email broadcasts test --example
# the body it prints:Code example
{
"contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
"from": "Jane Doe <jane@acme.com>",
"headers": {
"X-Campaign": "spring-launch"
},
"preview_fingerprint": "fingerprint_from_matching_preview",
"to": "member@example.com"
}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 | Idempotency-Key for retried test sends; reuse the same key with the identical request within the configured window. After expired requests are removed, the key can send another test even if the earlier response was not confirmed. (required) |
Options
| Name | Description |
|---|---|
--template | Override the template ID |
--language | Override the selected template language |
--parameters | Complete authored template input map as JSON; {} clears the map |
--parameter-overrides | Complete per-language override map as JSON; a name a language leaves out uses --parameters, and {} clears every override |
--from | Override sender address |
--reply-to <value>… | Override reply address; repeatable |
--header <key=value> | Replace headers as Key=Value |
--contact-id | Actual contact whose referenced values render |
--to | Current organization member email with workspace access (required; or in --body-file) |
--preview-fingerprint | Fingerprint from the matching fresh preview (required; or in --body-file) |
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird email broadcasts cancel | Cancel a broadcast |
bird email broadcasts counts | Get a broadcast's audience counts |
bird email broadcasts create | Create a broadcast |
bird email broadcasts delete | Delete a broadcast |
bird email broadcasts get | Get a broadcast |
bird email broadcasts list | List broadcasts |
bird email broadcasts list-clicked-links | List a broadcast's clicked links |
bird email broadcasts list-events | List events for a broadcast |
bird email broadcasts list-recipients | List recipients of a broadcast |
bird email broadcasts preview | preview a broadcast |
bird email broadcasts send | Send a broadcast |
bird email broadcasts send-quota | Get the email send allowance for a broadcast |
bird email broadcasts update | Update a draft or scheduled broadcast |
bird email broadcasts validate | validate a broadcast |
Related resources
Continue with the documentation, guides and examples for this topic.