Sign inGet Started

Publish a reusable email block

POST
/v1/email/blocks/{block_id}/publish
// Requires email_management:write permission in the target workspace.
const blockId = "ebl_01krdgeqcxet5s7t44vh8rt9mg";
const draft = await bird.email.blocks.languages.get(blockId, "en");
const submission = await bird.email.blocks.publish(blockId, {
  languages: [{ language: "en", revision: draft.revision }],
});
console.log(submission.status, submission.published_revisions);
响应200
{
  "id": "ebs_01krdgeqcxet5s7t44vh8rt9mg",
  "block_id": "ebl_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "published",
  "languages": [
    {
      "language": "pt-BR",
      "draft_revision": 8,
      "candidate_revision_id": "ebr_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "published_revisions": [
    {
      "language": "pt-BR",
      "id": "ebr_01krdgeqcxet5s7t44vh8rt9mg",
      "version_number": 3
    }
  ],
  "published_at": "2026-05-25T16:42:01Z",
  "created_at": "2026-05-25T16:42:01Z"
}

Publishes the current drafts of the named languages, each with the draft revision you last read. All named languages publish together or none do. Saving a draft never publishes.

Templates that link the block in a published language use the new content for mail that starts afterwards, including broadcasts already scheduled. A message scheduled on its own keeps the content it was accepted with.

A draft saved after you read it returns a 409 conflict_error, and a draft with no unpublished changes or invalid section content returns a 422 validation_error. So does a publication that would remove the only unsubscribe link from a live marketing template; the error names up to ten of those templates.

A publication that makes live templates using the block require a new input the sender supplies returns a 409 conflict_error naming the inputs and up to ten templates. Unlike a stale draft, it asks for review: once those senders supply the inputs, repeat the same languages and revisions with confirm set to true, under a new idempotency key.

参数

block_idstring

Block to read or edit.

请求载荷

languages
array of object
必填

Languages to publish, each with the draft revision last read.

显示子参数
languages.language
string
必填

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

languages.revision
integer
必填

Draft revision last read. A newer saved draft returns 409.

confirm
boolean

Publish even though live templates that use this block will start requiring inputs this publication adds. Without it, such a publication returns 409 naming the inputs and templates.

响应载荷

id
string
必填
block_id
string
必填
status
string
必填

Where a block change is in its lifecycle. published means its revisions are live. New values may be added; treat an unknown value as not yet live.

Possible values (may grow over time): published

languages
array of object
必填

Each included language, the draft revision it was taken from, and the snapshot frozen for it.

显示子属性
published_revisions
array of object
必填

The revisions that became live when this change was published.

显示子属性
published_at
string
必填
created_at
string
必填