`bird email broadcasts preview`

Usage

Code example

bird email broadcasts preview <broadcast-id> [flags]

Description

preview a broadcast

Render the template's published content without sending email. Contact data requires --contact-id for an authorized contact. Requires broadcast and template read permission.

Build the request from the <broadcast_id> argument and flags, a JSON EmailBroadcastPreviewRequest 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 4 of 5 of "Preview and test a broadcast". Previous: bird email broadcasts validate. Next: bird email broadcasts test.

Examples

Code example

# print the body shape (no credentials needed)
bird email broadcasts preview --example

# the body it prints:

Code example

{
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "from": "Jane Doe <jane@acme.com>",
  "headers": {
    "X-Campaign": "spring-launch"
  }
}

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
`--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
`--response-schema`	Print the fields this command returns, then exit

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 send`	Send a broadcast
`bird email broadcasts send-quota`	Get the email send allowance for a broadcast
`bird email broadcasts test`	test a broadcast
`bird email broadcasts update`	Update a draft or scheduled broadcast
`bird email broadcasts validate`	validate a broadcast

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources