Create a batch of email messages

Creates up to 1,000 email messages in a single request. Request-wide admission checks run first and can reject the whole batch before message creation. After those checks pass, each message is validated and sent independently; item-level failures do not affect other messages, and the processed batch returns 207 Multi-Status. Per-message failures include validation errors; when a template has strict_variables enabled, a missing required variable produces a per-item unprocessable_entity error naming that variable while the other messages continue.

POST

email_messages

batch

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.emailMessages.batch({
  messages: [],
});

console.log(response.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
)
response = client.email_messages.batch(
    messages=[],
)
print(response.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"),
	)
	response, err := client.EmailMessages.Batch(
		context.TODO(),
		telnyx.EmailMessageBatchParams{
			Messages: "messages",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.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.EmailMessageBatchParams;
import java.util.List;

public final class Main {
    private Main() {}

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

        EmailMessageBatchParams params = EmailMessageBatchParams.builder()
            .messages(List.of())
            .build();
        var response = client.emailMessages().batch(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 {
  $response = $client->emailMessages->batch(
    messages: [],
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/email_messages/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sandbox_mode": false,
  "messages": [
    {
      "from": "sender@example.com",
      "to": [
        "recipient1@example.com"
      ],
      "subject": "Hello 1",
      "text_body": "Message 1"
    },
    {
      "from": "sender@example.com",
      "to": [
        "recipient2@example.com"
      ],
      "subject": "Hello 2",
      "text_body": "Message 2"
    }
  ]
}
'

{
  "data": [
    {
      "record_type": "email_message",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued",
      "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": {},
      "tags": [],
      "metadata": {},
      "attachments": [
        {
          "url": "<string>",
          "sha256": "<string>",
          "size_bytes": 123,
          "filename": "<string>",
          "content_type": "<string>",
          "disposition": "attachment",
          "content_id": "<string>"
        }
      ],
      "events": [
        {
          "type": "queued",
          "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": [
    {
      "index": 1,
      "code": "bad_request",
      "message": "<string>"
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  }
}

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

messages

object[]

required

Array of email messages to send. Up to 1,000 messages per batch request. Each message is validated and sent independently; per-message failures do not affect other messages in the batch.

Required array length: 1 - 1000 elements

Show child attributes

sandbox_mode

boolean

default:false

Applies sandbox mode to all messages in the batch and overrides any per-message sandbox_mode value — each message's effective sandbox_mode is exactly this envelope value. Reserved recipients at test.telnyx.com produce the deterministic event chains documented on CreateEmailRequest.sandbox_mode; no batch item is injected into the MTA or outbound Kafka path. Sandbox batch items are non-billable, consume no daily-send-limit quota, and feed no delivery-reputation signals.

Response

Multi-Status — returned after request-wide admission checks pass and item processing runs. Each message is validated and sent independently; per-message failures do not affect other messages in the batch. An invalid or non-future scheduled_at/send_at is reported as a per-item unprocessable_entity error while the remaining items continue. When all messages succeed, errors is empty and every item is in data; otherwise data contains successes and errors contains failures. Request-wide gates can instead return 4xx or 5xx.

data

object[]

required

Show child attributes

errors

object[]

required

Show child attributes

meta

object

required

Show child attributes

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.emailMessages.batch({
  messages: [],
});

console.log(response.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
)
response = client.email_messages.batch(
    messages=[],
)
print(response.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"),
	)
	response, err := client.EmailMessages.Batch(
		context.TODO(),
		telnyx.EmailMessageBatchParams{
			Messages: "messages",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.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.EmailMessageBatchParams;
import java.util.List;

public final class Main {
    private Main() {}

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

        EmailMessageBatchParams params = EmailMessageBatchParams.builder()
            .messages(List.of())
            .build();
        var response = client.emailMessages().batch(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 {
  $response = $client->emailMessages->batch(
    messages: [],
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/email_messages/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sandbox_mode": false,
  "messages": [
    {
      "from": "sender@example.com",
      "to": [
        "recipient1@example.com"
      ],
      "subject": "Hello 1",
      "text_body": "Message 1"
    },
    {
      "from": "sender@example.com",
      "to": [
        "recipient2@example.com"
      ],
      "subject": "Hello 2",
      "text_body": "Message 2"
    }
  ]
}
'

{
  "data": [
    {
      "record_type": "email_message",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued",
      "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": {},
      "tags": [],
      "metadata": {},
      "attachments": [
        {
          "url": "<string>",
          "sha256": "<string>",
          "size_bytes": 123,
          "filename": "<string>",
          "content_type": "<string>",
          "disposition": "attachment",
          "content_id": "<string>"
        }
      ],
      "events": [
        {
          "type": "queued",
          "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": [
    {
      "index": 1,
      "code": "bad_request",
      "message": "<string>"
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  }
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

Create a batch of email messages

Authorizations

Headers

Body

Response