email-templates

Get published email template parameters

Get the parameters and variables used by the template's published content in one language. The result describes the template and holds no saved values. Parameters are the names a broadcast supplies in template.parameters, and variables are the bird. references Bird fills in. The result identifies list values, which broadcast parameters cannot supply. It also includes a fingerprint that identifies the published content without exposing contact values. You cannot select an older template version. Requires email_marketing read permission in addition to email_management read. Parameter sites cover template subject, HTML and text; envelope overrides are checked by broadcast validation.

get/v1/email/templates/{template_ref}/parameters

Request

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

Path parameters

template_refstring required

Workspace template ID, workspace template slug, or built-in template slug.

Query parameters

languagestring

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

Example:pt-BR

Language of the template's published content. Omission uses the template's default language.

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

The parameters and variables of the current published content.

template_idstring required
observed_version_idstring required
requested_languagestring

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

effective_languagestring required

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

requirements_fingerprintstring required

An opaque value that changes when this content or the parameters and variables it uses change, including for built-in templates whose version ID stays the same. Compare it with an earlier value to tell whether they are still the same. Do not parse it.

Example response

{
  "template_id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
  "observed_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
  "requested_language": "pt-BR",
  "effective_language": "pt-BR",
  "parameters": [
    {
      "name": "offer",
      "type": "text",
      "value_domain": "scalar",
      "use_constraints": [
        {
          "kind": "value",
          "site": "html"
        }
      ]
    }
  ],
  "variables": [
    {
      "path": "bird.contact.first_name",
      "source": "contact",
      "use_constraints": [
        {
          "kind": "value",
          "site": "html"
        }
      ]
    }
  ]
}

Changes

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