Email Templates

Create an email template

Changed on

Creates a Liquid email template. Variables are auto-extracted when omitted.

post/email_templates

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_templates
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

namestring required

Letters, numbers, spaces, hyphens, and underscores only.

subjectstring nullable

Liquid template subject.

html_bodystring nullable

Liquid template HTML body.

text_bodystring nullable

Liquid template text body.

variablesstring[] nullable

Persisted variable names. In automatic mode a non-null array is rejected; in explicit mode this is the exact manual array and each item is limited to 255 Unicode code points.

variables_mode'automatic' | 'explicit'

Controls how variables is maintained. If both fields are omitted (or variables is null), the template uses automatic mode and extracts variable names from the effective subject, HTML body, and text body. A non-null variables array with no mode selects explicit. automatic rejects a simultaneous non-null array; explicit requires a non-null array, including valid [], and preserves its exact order, duplicates, and string contents.

strict_variablesboolean

Per-template strict variable-validation setting. Defaults to false for backward compatibility. When true, a send or render that is missing a variable marked required: true in variable_schema fails with 422 naming the variable. Missing optional variables never fail; their schema default (when set) is applied to the render.

autoescapeboolean

Per-template HTML autoescaping setting. Defaults to false for backward compatibility. When true, the rendered html_body HTML-escapes each Liquid expression's output at the output boundary (after its filters run, before concatenation with literal template markup). Input values are never mutated and subject/text_body are never autoescaped. The boundary escape is idempotent: HTML entities already present in the output (e.g. from an explicit escape filter) are preserved, so an explicit escape/escape_once is never double-escaped, and markup introduced by any later filter in the chain is still escaped.

variable_schemaobject nullable

Structured variable requirements. Required variables cannot define defaults; invalid combinations return 422. This is independent of the legacy variables array. On render with strict_variables enabled: required variables must be supplied as non-empty values — absent, null, empty string, empty object {}, and empty array [] all fail with 422 naming the variable, while present values such as false and 0 pass (they are present, not empty). Optional variables fall back to their default when absent.

Response

Template created.

Changes

  • da303e40b51eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      added subschema #2 to the response property allOf list for the response status

  • 16bfa298dc71Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status