Sign inGet Started

Update a reusable email block

PATCH
/v1/email/blocks/{block_id}
// Requires email_management:write permission in the target workspace.
const current = await bird.email.blocks.get("ebl_01krdgeqcxet5s7t44vh8rt9mg");
const block = await bird.email.blocks.update(current.id, {
  revision: current.revision,
  archived: true,
});
console.log(block.archived_at);
Response200
{
  "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"
}

Changes a block's name, description, archive state or source language, using the revision you last read. A stale revision returns a 409 conflict_error. The source language can change until the block is first published.

Templates that already link an archived block keep filling it, and new links to it are refused. Unarchive the block to link it again.

Parameters

block_idstring

Block to read or edit.

Request Payload

revision
integer
required

Metadata revision last read. A concurrent change returns 409.

name
string

New name for the block.

description
string

Replacement maintenance notes. Send an empty string to clear them.

source_language
string

An existing block language. It can change only before the first publication.

archived
boolean

Archive or unarchive the block. Archiving retains its content and history.

Response Payload

id
string
required
name
string
required

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
required

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

revision
integer
required

Metadata revision to send when editing or duplicating this block.

created_by
object
required

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

Show child attributes
archived_at
string

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

created_at
string
required
updated_at
string
required

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