Sign inGet Started

Create a reusable email block

POST
/v1/email/blocks
// Requires email_management:write permission in the target workspace.
const section =
  '<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;">Offer valid until {{ expiry_date }}.</p></td></tr></tbody></table>';
const block = await bird.email.blocks.create({
  name: "Legal footer",
  source_language: "en",
  fragment: { serializer_version: 2, fragment_html: section },
});
console.log(block.id, block.revision);
响应201
{
  "id": "ebl_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Legal disclosure",
  "source_language": "pt-BR",
  "revision": 1,
  "created_by": {
    "id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
    "type": "user"
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Creates an unpublished block with a draft in its source language. Send the section as HTML in fragment, with serializer_version set to 2: one presentation table whose single content cell sets lang to the source language and its own typography, under the rules fragment_html lists. Unfinished content can be saved; validating or publishing the block checks it.

The block is not live until you publish it. Each language keeps the authoring mode of its first section, so a section written as HTML stays HTML.

请求载荷

name
string
必填

Name for people choosing the block, such as when linking it into a template.

description
string

Optional notes for people maintaining the block.

source_language
string
必填

A language tag in BCP-47 form, for example en or pt-BR.

fragment
object

Initial source-language content, as an HTML section. Its serializer_version sets the language's authoring mode. Leaving it out returns a 422 validation_error, except in the Bird dashboard, which starts an empty visual draft.

显示子参数

响应载荷

id
string
必填
name
string
必填

Name for people choosing the block, such as when linking it into a template.

description
string

Optional notes for people maintaining the block. Omitted when empty.

source_language
string
必填

A language tag in BCP-47 form, for example en or pt-BR.

revision
integer
必填

Metadata revision to send when editing or duplicating this block.

created_by
object
必填

Who created the block. A duplicate is created by whoever duplicated it.

显示子属性
archived_at
string

Present when the block is archived. Retained published content remains readable.

created_at
string
必填
updated_at
string
必填