---
title: "Update a reusable email block"
canonical: "https://bird.com/docs/api/reference/update-email-block"
---

# Update a reusable email block

`PATCH /v1/email/blocks/{block_id}`

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.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

## Code samples

**TypeScript**

```ts
// 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);
```

Examples: [TypeScript](/docs/api/reference/update-email-block.ts.md) · [Python](/docs/api/reference/update-email-block.py.md) · [Go](/docs/api/reference/update-email-block.go.md) · [PHP](/docs/api/reference/update-email-block.php.md) · [CLI](/docs/api/reference/update-email-block.cli.md) · [MCP](/docs/api/reference/update-email-block.mcp.md) · [cURL](/docs/api/reference/update-email-block.curl.md)

## Example response `200`

```json
{
  "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"
}
```

## Path parameters

- `block_id` (string, required): Block to read or edit.

## Header parameters

- `Idempotency-Key` (string, optional)

  Client-supplied key. On operations supporting request deduplication, a retained
  response is replayed for duplicate requests with the same key within the
  idempotency window (3 hours by default). This protection requires a workspace,
  organization, or staff-account scope. User-only and unscoped unauthenticated operations,
  streams, and operations with a separate replay contract do not use this
  response replay.

  On a supported operation, if idempotency protection is unavailable before execution, the API returns
  `503 IdempotencyUnavailable` (E01033) without executing this attempt. Retry with
  backoff using the same key and request. An operation that takes effect before
  its response is retained can still execute again on retry.

  Two distinct 409 errors signal misuse:

  - `request_in_progress` (E01004): The same key is currently being
    processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  - `idempotency_key_reuse` (E01005): The same key has already completed
    against a different request body or method. Generate a new key.

  Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Request body

- `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 body

- `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.
- `created_by.id` (string, required): Actor identifier.
- `created_by.type` (string, required)

  New actor types may be added. Treat unrecognized values as future types, not errors.
  - `user`: a member's own session.
  - `api_key`: a workspace API key.
  - `oauth_token`: a token issued to a caller on a member's behalf.
  - `system`: an action we perform without a customer actor.
  - `sso`: an organization's SSO connection.
  - `service_account`: a workspace's connected Integration acting with no member behind it.
  - `automation`: an automation execution in your workspace.

  Possible values (may grow over time): `user`, `api_key`, `oauth_token`, `system`, `sso`, `service_account`, `automation`
- `created_by.display_name` (nullable string): The label the actor is shown under: typically a member's name or email address, or the API key's name. Null when it could not be resolved.
- `archived_at` (string): Present when the block is archived. Retained published content remains readable.
- `created_at` (string, required)
- `updated_at` (string, required)

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)
