Create or send an email message

POST

email_messages

JavaScript

import Telnyx from 'telnyx';

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

const EmailMessage = await client.emailMessages.create({
  from: 'from',
  to: 'to',
});

console.log(EmailMessage.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_message = client.email_messages.create(
    from_="from",
    to="to",
)
print(email_message.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"),
	)
	emailMessage, err := client.EmailMessages.New(
		context.TODO(),
		telnyx.EmailMessageNewParams{
			From: "from",
			To:   "to",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailMessage.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailMessages.EmailMessageCreateParams;

public final class Main {
    private Main() {}

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

        EmailMessageCreateParams params = EmailMessageCreateParams.builder()
            .from("from")
            .to("to")
            .build();
        var response = client.emailMessages().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_message = $client->emailMessages->create(
    from: 'from',
    to: 'to',
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/email_messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "sender@example.com",
  "to": [
    "recipient@example.com"
  ],
  "subject": "Hello from Telnyx",
  "text_body": "This is a test email."
}
'

{
  "data": {
    "record_type": "email_message",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from": {
      "email": "<string>",
      "name": "<string>"
    },
    "to": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "cc": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "bcc": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "reply_to": "<string>",
    "subject": "<string>",
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template_variables": {},
    "attachments": [
      {
        "url": "<string>",
        "sha256": "<string>",
        "size_bytes": 123,
        "filename": "<string>",
        "content_type": "<string>",
        "disposition": "attachment",
        "content_id": "<string>"
      }
    ],
    "events": [
      {
        "occurred_at": "2023-11-07T05:31:56Z",
        "payload": {}
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "scheduled_at": "2023-11-07T05:31:56Z",
    "inline_css": true,
    "sandbox": true,
    "recipient_statuses": {
      "delivered": 998,
      "bounced": 2
    }
  },
  "suppressed": [
    {
      "to": "jsmith@example.com",
      "reason": "<string>",
      "scope": "<string>",
      "override_allowed": true
    }
  ]
}

{
  "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": "10007",
      "title": "Forbidden",
      "detail": "Domain is not verified. Complete DNS setup before sending email."
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested resource was not found"
    }
  ]
}

{
  "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": "10027",
      "title": "Unprocessable Entity",
      "detail": "The server understood the syntax of the request but was unable to process the instructions."
    }
  ]
}

{
  "errors": [
    {
      "code": "reputation_suspended",
      "title": "Sending Suspended",
      "detail": "<string>"
    }
  ]
}

{
  "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

Recipient email addresses must be unique across to, cc, and bcc after case-insensitive normalization. Duplicate recipients return 400 Bad Request.

from

required

(string | object)[]

required

Minimum array length: 1

from_name

string

Optional display name for string from; overrides from.name when provided.

(string | object)[]

bcc

(string | object)[]

reply_to

Reply-to address. If provided as an object with a name, only the email is stored; the name is ignored.

subject

string

Required unless template_id is supplied. When using a template, the template's subject is rendered; if the template has no subject or renders empty, the request returns 400.

html_body

string

HTML email body. Returned only by GET /email_messages/{id}; omitted from create and list responses.

text_body

string

Plain text email body. Returned only by GET /email_messages/{id}; omitted from create and list responses.

headers

object

Custom email headers. Write-only; not returned in responses.

Show child attributes

attachments

object[]

Show child attributes

Response

Message queued, scheduled, or sandbox-created.

data

object

required

Show child attributes

suppressed

object[]

Recipients removed by suppression checks when at least one recipient remains and the message is accepted.

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 EmailMessage = await client.emailMessages.create({
  from: 'from',
  to: 'to',
});

console.log(EmailMessage.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_message = client.email_messages.create(
    from_="from",
    to="to",
)
print(email_message.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"),
	)
	emailMessage, err := client.EmailMessages.New(
		context.TODO(),
		telnyx.EmailMessageNewParams{
			From: "from",
			To:   "to",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailMessage.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailMessages.EmailMessageCreateParams;

public final class Main {
    private Main() {}

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

        EmailMessageCreateParams params = EmailMessageCreateParams.builder()
            .from("from")
            .to("to")
            .build();
        var response = client.emailMessages().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_message = $client->emailMessages->create(
    from: 'from',
    to: 'to',
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/email_messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "sender@example.com",
  "to": [
    "recipient@example.com"
  ],
  "subject": "Hello from Telnyx",
  "text_body": "This is a test email."
}
'

{
  "data": {
    "record_type": "email_message",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from": {
      "email": "<string>",
      "name": "<string>"
    },
    "to": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "cc": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "bcc": [
      {
        "email": "<string>",
        "name": "<string>"
      }
    ],
    "reply_to": "<string>",
    "subject": "<string>",
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template_variables": {},
    "attachments": [
      {
        "url": "<string>",
        "sha256": "<string>",
        "size_bytes": 123,
        "filename": "<string>",
        "content_type": "<string>",
        "disposition": "attachment",
        "content_id": "<string>"
      }
    ],
    "events": [
      {
        "occurred_at": "2023-11-07T05:31:56Z",
        "payload": {}
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "scheduled_at": "2023-11-07T05:31:56Z",
    "inline_css": true,
    "sandbox": true,
    "recipient_statuses": {
      "delivered": 998,
      "bounced": 2
    }
  },
  "suppressed": [
    {
      "to": "jsmith@example.com",
      "reason": "<string>",
      "scope": "<string>",
      "override_allowed": true
    }
  ]
}

{
  "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": "10007",
      "title": "Forbidden",
      "detail": "Domain is not verified. Complete DNS setup before sending email."
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested resource was not found"
    }
  ]
}

{
  "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": "10027",
      "title": "Unprocessable Entity",
      "detail": "The server understood the syntax of the request but was unable to process the instructions."
    }
  ]
}

{
  "errors": [
    {
      "code": "reputation_suspended",
      "title": "Sending Suspended",
      "detail": "<string>"
    }
  ]
}

{
  "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 or send an email message

Authorizations

Headers

Body

Response