Documentation
Sign inGet started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get one language of a version

GET
/v1/email/templates/{template_ref}/versions/{version_id}/languages/{language}
bird email templates versions languages get <template-ref> <version-id> <language>
Response200
{
  "language": "pt-BR",
  "content_hash": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "content": {
    "subject": "Welcome to Acme, {{ bird.contact.first_name }}!",
    "preview_text": "{{ bird.contact.first_name }}, your order is on its way",
    "html": "<h1>Hi {{ bird.contact.first_name }}</h1>"
  },
  "compatibility_severity": "warning",
  "compatibility": [
    {
      "rule_id": "css_display_flex_grid",
      "severity": "warning",
      "language": "pt-BR",
      "field": "html",
      "message": "`display: flex` and `grid` don't work in Outlook (Windows/Windows Mail).",
      "fix": "Use tables for layout.",
      "partial": "Partial support for `display: flex` and `grid` in Gmail (iOS/Android).",
      "line": 14,
      "column": 6,
      "match": "display: flex",
      "unsupported_clients": [
        {
          "family": "outlook",
          "platforms": [
            "windows",
            "windows_mail"
          ]
        }
      ],
      "partial_clients": [
        {
          "family": "outlook",
          "platforms": [
            "windows",
            "windows_mail"
          ]
        }
      ]
    }
  ]
}
Returns one language's content from a version (its subject and bodies) plus the revision to send back when saving it.
Works on any version, including a published version whose content is frozen. Returns a 404 Not Found error if the version does not have the language.
Parameters
template_ref
string
The template's id (emt_…) or slug. On read, a built-in system template's bird_ slug also resolves here. Writing or removing a language requires a workspace template, because a system template has no draft to edit and returns 404 not_found_error.
version_id
string
language
string
Response Payload
language
string
required
The language this content belongs to, in its canonical form. Send a tag in any casing and this reports the form the template stores.
revision
integer
required
This language's revision counter. Send it back when you save this language so a concurrent edit is caught instead of silently overwritten. It counts only this language's own changes, so editing another language never invalidates it.
content_hash
nullable string
A hash over this language's content, prefixed with the algorithm that produced it (sha256:), so the algorithm can change without the field becoming ambiguous. It tells you whether a language differs without transferring the content, and is comparable only within one version of this API. Null for a language saved before fingerprints were recorded.
updated_at
nullable string
When this language was last saved. Null if that is not recorded.
content
object
One language's content for an email template. Each language carries its own subject, preview text and bodies, so a translation can differ in wording and length from every other language without affecting them.
Show child attributes
content.subject
string
The email subject line for this language.
content.preview_text
string
The line an inbox shows after the subject in the message list, for this language. Leave it out and the inbox shows the opening words of the body instead. A mail client only reads it from the message body, so publishing folds it into the top of the HTML, hidden from view once the message is open; write it here rather than hiding your own copy in the body.
content.html
string
The HTML body for this language.
content.text
string
The plain-text body for this language. Omit it and a plain-text alternative is derived from the HTML when you submit.
compatibility_severity
string
required
The worst severity across every finding the response was computed from, which is the authoritative reading: a response that caps how many findings it lists still accounts here for the ones it left out. Each response's compatibility says which content it covered.
  • problem: at least one finding is a problem.
  • warning: every finding is a warning.
  • none: there are no findings.
Possible values: problem, warning, none
compatibility
array of object
required
What the stored HTML uses that mail clients remove, ignore, or render inconsistently, in the order the patterns appear. Empty when nothing is worth reporting. Line and column count in the content.html this response carries. At most 200 findings come back, the first 200 in source order; compatibility_severity is derived from every finding the HTML produced, including any beyond those 200.
Show child attributes
compatibility.rule_id
string
required
The rule that produced this finding.
Possible values (may grow over time): html_script, html_event_handlers, html_embedded_content, html_linked_stylesheet, css_at_import, html_form, html_svg, html_media, css_display_flex_grid, css_position_fixed_sticky, css_variables_no_fallback, css_viewport_units, html_button, css_math_functions, css_modern_color, html_web_page_markup
compatibility.severity
string
required
What a finding costs you.
  • problem: the pattern does nothing at all. The client removes the markup, never loads the stylesheet carrying it, or will not operate the control. Where a finding names clients, that is what happens in those clients.
  • warning: it does something, but not what you wrote.
Neither one refuses a save, a submit, or a send.
Possible values: problem, warning
compatibility.language
nullable string
required
Which language's content this finding is in. Null when the call covered a single language.
compatibility.field
string
required
Which field of that language the finding is in. Always html; the subject and the plain-text body are not checked.
compatibility.message
string
required
What is wrong and which clients it affects, worded to show to whoever is authoring the template. It covers the rule's whole category rather than the exact text that matched, so a rule covering <video> and <audio> names both whichever one is on the line. Show fix and then partial after it.
compatibility.fix
nullable string
required
What to use instead. Null when there is no drop-in alternative and the fix is a restructure.
compatibility.partial
nullable string
required
Which clients support the feature only partly. Null when no client's support is partial.
compatibility.line
integer
required
The 1-based line the pattern is on, in the HTML the containing response's compatibility says it covered.
compatibility.column
integer
required
The 1-based column the pattern starts at, on that line.
compatibility.match
string
required
The source text that matched, starting at line and column: the smallest span that identifies what is wrong. Never the enclosing line. For a finding on a whole element, the span runs from the opening tag through the close tag, because the client drops the element's content along with its markup. Cut at 256 characters, so an element holding a long body is quoted from its start rather than in full.
compatibility.unsupported_clients
array of object
required
Every client family that does not support the feature at all, in alphabetical order by each entry's family. Empty on a finding whose message, fix, and partial name no client. message names at most four families; this names all of them.
Show child attributes
compatibility.unsupported_clients.family
string
required
Which mail client a finding applies to. A finding's message names at most Apple Mail, Gmail, Outlook, and Yahoo; its unsupported_clients and partial_clients name every client affected.
  • gmail: Gmail
  • outlook: Outlook
  • yahoo: Yahoo
  • apple_mail: Apple Mail
  • aol: AOL
  • thunderbird: Mozilla Thunderbird
  • samsung_email: Samsung Email
  • sfr: SFR
  • orange: Orange
  • protonmail: ProtonMail
  • hey: HEY
  • mail_ru: Mail.ru
  • fastmail: Fastmail
  • laposte: LaPoste.net
  • gmx: GMX
  • web_de: WEB.DE
  • ionos_1and1: 1&1
  • wp_pl: WP.pl
Possible values (may grow over time): gmail, outlook, yahoo, apple_mail, aol, thunderbird, samsung_email, sfr, orange, protonmail, hey, mail_ru, fastmail, laposte, gmx, web_de, ionos_1and1, wp_pl
compatibility.unsupported_clients.platforms
array of string
required
Which of the family's platforms this applies to, in alphabetical order.
compatibility.partial_clients
array of object
required
Every client family that renders something other than what you wrote, in alphabetical order by each entry's family. Empty when no client's support is partial, which is also when partial is null. partial names at most four families; this names all of them.
Show child attributes
compatibility.partial_clients.family
string
required
Which mail client a finding applies to. A finding's message names at most Apple Mail, Gmail, Outlook, and Yahoo; its unsupported_clients and partial_clients name every client affected.
  • gmail: Gmail
  • outlook: Outlook
  • yahoo: Yahoo
  • apple_mail: Apple Mail
  • aol: AOL
  • thunderbird: Mozilla Thunderbird
  • samsung_email: Samsung Email
  • sfr: SFR
  • orange: Orange
  • protonmail: ProtonMail
  • hey: HEY
  • mail_ru: Mail.ru
  • fastmail: Fastmail
  • laposte: LaPoste.net
  • gmx: GMX
  • web_de: WEB.DE
  • ionos_1and1: 1&1
  • wp_pl: WP.pl
Possible values (may grow over time): gmail, outlook, yahoo, apple_mail, aol, thunderbird, samsung_email, sfr, orange, protonmail, hey, mail_ru, fastmail, laposte, gmx, web_de, ionos_1and1, wp_pl
compatibility.partial_clients.platforms
array of string
required
Which of the family's platforms this applies to, in alphabetical order.

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideHow to build an email templateExplore the capabilityEmail templatesFollow the learning pathBuild your first integrationImplementation guideEmail templates
Try the practice and get an implementation brief