email-templates

Get an email template version

Returns a single version of an email template:

  • Its lifecycle metadata (status, version_number, published_at).
  • The content it froze in every language.
  • Its variables: the parameters you supply when sending and the values Bird fills in for each recipient, told apart by system.

Use List email template versions to enumerate the draft and published versions. Roll back an email template makes an earlier published version live again. Returns a 404 Not Found error if the template or version does not exist in the workspace.

get/v1/email/templates/{template_ref}/versions/{version_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/templates/{template_ref}/versions/{version_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

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-Idstring

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.

Response

Email template version object.

idstring required
template_idstring required
version_numberinteger nullable

Sequential published-version number (1, 2, 3…). Null while the version is a draft.

status'draft' | 'published' | 'archived' required

Whether this version is still being edited or has been published. It records the version's publication history: a version that a later one replaced stays published. The template's live_version_id names the version a send resolves to now.

archived is reserved and no version carries it yet. Version retirement will produce it, so it is declared here ahead of that feature: a client written against this list today keeps working when the first archived version arrives, rather than the value's arrival being a breaking change.

revisioninteger required

The version's revision counter.

languagesobject required

The content this version holds, keyed by language tag in BCP-47 form such as en or pt-BR. Publishing freezes every language together, so a version shows exactly what it would send in each of them. On a published version this is the send content.

default_languagestring required

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

created_atstring date-time required

When this version was created.

published_atstring date-time nullable

When this version was published, or null if it has not been published.

Example response

{
  "id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
  "template_id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "published",
  "default_language": "pt-BR",
  "updated_by": {
    "id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
    "type": "user"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.