Create an email template

POST

email_templates

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const EmailTemplate = await client.emailTemplates.create({
  name: 'name',
});

console.log(EmailTemplate.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
email_template = client.email_templates.create(
    name="name",
)
print(email_template.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailTemplate, err := client.EmailTemplates.New(
		context.TODO(),
		telnyx.EmailTemplateNewParams{
			Name: "name",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailTemplate.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailTemplates.EmailTemplateCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        EmailTemplateCreateParams params = EmailTemplateCreateParams.builder()
            .name("name")
            .build();
        var response = client.emailTemplates().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $email_template = $client->emailTemplates->create(
    name: 'name',
  );

  var_dump($email_template);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/email_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Welcome Email",
  "subject": "Welcome, {{ first_name }}!",
  "html_body": "<h1>Hello {{ first_name }}</h1>",
  "text_body": "Hello {{ first_name }}"
}
'

{
  "data": {
    "record_type": "email_template",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "subject": "<string>",
    "html_body": "<string>",
    "text_body": "<string>",
    "variables": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "email is required"
    }
  ]
}

{
  "errors": [
    {
      "code": "10006",
      "title": "Not authorized",
      "detail": "Invalid API key",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10006"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10036",
      "title": "Resource is being processed",
      "detail": "A request with this Idempotency-Key is already being processed.",
      "source": {
        "pointer": "/header/Idempotency-Key"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured."
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "subject can't be blank",
      "source": {
        "pointer": "/data/attributes/subject"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10016",
      "title": "Service Unavailable",
      "detail": "The email domain service is temporarily unavailable. Please try again later."
    }
  ]
}

Authorizations

Authorization

string

header

required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Headers

Idempotency-Key

string

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.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_-]{1,255}$

Body

application/json

name

string

required

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

Pattern: ^[A-Za-z0-9 _-]+$

subject

string | null

Liquid template subject.

html_body

string | null

Liquid template HTML body.

text_body

string | null

Liquid template text body.

variables

string[]

Template variables. Auto-extracted from subject/body fields when absent.

Response

Template created.

data

object

required

Show child attributes

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const EmailTemplate = await client.emailTemplates.create({
  name: 'name',
});

console.log(EmailTemplate.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
email_template = client.email_templates.create(
    name="name",
)
print(email_template.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailTemplate, err := client.EmailTemplates.New(
		context.TODO(),
		telnyx.EmailTemplateNewParams{
			Name: "name",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailTemplate.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailTemplates.EmailTemplateCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        EmailTemplateCreateParams params = EmailTemplateCreateParams.builder()
            .name("name")
            .build();
        var response = client.emailTemplates().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $email_template = $client->emailTemplates->create(
    name: 'name',
  );

  var_dump($email_template);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/email_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Welcome Email",
  "subject": "Welcome, {{ first_name }}!",
  "html_body": "<h1>Hello {{ first_name }}</h1>",
  "text_body": "Hello {{ first_name }}"
}
'

{
  "data": {
    "record_type": "email_template",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "subject": "<string>",
    "html_body": "<string>",
    "text_body": "<string>",
    "variables": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "email is required"
    }
  ]
}

{
  "errors": [
    {
      "code": "10006",
      "title": "Not authorized",
      "detail": "Invalid API key",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10006"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10036",
      "title": "Resource is being processed",
      "detail": "A request with this Idempotency-Key is already being processed.",
      "source": {
        "pointer": "/header/Idempotency-Key"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured."
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "subject can't be blank",
      "source": {
        "pointer": "/data/attributes/subject"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10016",
      "title": "Service Unavailable",
      "detail": "The email domain service is temporarily unavailable. Please try again later."
    }
  ]
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

Create an email template

Authorizations

Headers

Body

Response