Sign inGet Started

bird email blocks create

Usage

Code example
bird email blocks create <name> [flags]

Description

Create a reusable email block

Create an unpublished block with one source-language draft at draft revision 1. Send the section in fragment as HTML: serializer_version 2 and fragment_html. Version 1 is reserved for the Bird dashboard's visual editor. Unfinished content saves and is checked later. Creating never publishes: check the section with bird email blocks validate, then publish it with bird email blocks publish.

Build the request from the <name> argument and flags, a JSON EmailBlockCreate 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 1 of 7 of "Author a reusable email section and link it into templates". Next: bird email blocks validate.

Examples

Code example
# print the body shape (no credentials needed)
bird email blocks create --example

# the body it prints:
Code example
{
  "fragment": {
    "fragment_html": "<table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\"><tbody><tr><td lang=\"en\" style=\"font-family: Arial, sans-serif; font-size: 14px; font-style: normal; font-weight: normal; line-height: 20px; letter-spacing: normal; text-align: left; text-transform: none; color: #333333; margin: 0; padding: 16px;\"><p style=\"margin: 0;\">Your disclosure text.</p></td></tr></tbody></table>",
    "serializer_version": 2
  },
  "name": "Legal disclosure",
  "source_language": "en"
}

Options

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
--descriptionOptional notes for people maintaining the block.
--source-languageA language tag in BCP-47 form, for example en or pt-BR. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email blocks duplicateDuplicate a reusable email block
bird email blocks getGet a reusable email block
bird email blocks listList reusable email blocks
bird email blocks publishPublish a reusable email block
bird email blocks updateUpdate a reusable email block
bird email blocks validateValidate a reusable email section

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