Sign inGet Started

Get a published block revision

GET
/v1/email/blocks/{block_id}/languages/{language}/revisions/{revision_id}
// Requires email_management:read permission in the target workspace.
const revision = await bird.email.blocks.languages.revisions.get(
  "ebl_01krdgeqcxet5s7t44vh8rt9mg",
  "en",
  "ebr_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(revision.version_number, revision.fragment.fragment_html);
Odpowiedź200
{
  "id": "ebr_01krdgeqcxet5s7t44vh8rt9mg",
  "version_number": 1,
  "serializer_version": 2,
  "authoring_mode": "html",
  "published_by": {
    "id": "key_01krdgeqcxet5s7t44vh8rt9mg",
    "type": "api_key",
    "display_name": "Release pipeline"
  },
  "fragment": {
    "serializer_version": 2,
    "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>"
  },
  "published_at": "2026-05-25T16:42:01Z",
  "created_at": "2026-05-25T16:42:01Z"
}

Returns one published revision of the exact block and language, including for archived blocks. To make it the draft again, save the language with from_revision_id. A revision that was never published returns a 404 not_found_error.

Parametry

block_idstring

Block to read or edit.

languagestring

Exact block language as a BCP-47 tag. No fallback is applied.

revision_idstring

Retained published revision to read.

Treść odpowiedzi

id
string
wymagane
version_number
integer
wymagane

Publication number within this block language. A draft's revision is the value to send back when saving, not a publication number.

serializer_version
integer
wymagane

Format used to save and render this section: 2 for a section written as HTML, 1 for one built in the Bird dashboard's visual editor.

authoring_mode
string
wymagane

How this language is edited. html content is written as HTML and can be changed through the API, CLI and MCP. visual content is built in the Bird dashboard's visual editor; outside the dashboard, a visual section can still be copied by duplicating its block or restoring a published revision. The mode follows from the stored content and cannot be set directly. New values may be added; treat an unknown value as content you cannot edit through the API, CLI or MCP.

Possible values (may grow over time): visual, html

source_revision_id
string

Source-language revision used for this translation. Omitted when untracked.

published_by
object
wymagane

Who published this revision.

Pokaż atrybuty podrzędne
published_by.id
string
wymagane

Actor identifier.

published_by.type
string
wymagane

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

published_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.

published_at
string
wymagane
created_at
string
wymagane
fragment
object
wymagane

One self-contained email section. Version 2 is a section written as HTML and sends fragment_html alone; the API, SDKs, CLI and MCP write version 2. Version 1 is reserved for sections built in the Bird dashboard's visual editor, and only the dashboard saves it. A block language keeps the version it was created with.

Pokaż atrybuty podrzędne

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.