Отправить письмо

API 0.16.0OpenAPIllms-full.txt

POST/v1/mailboxes/{mailbox_id}/send

Обязателен Idempotency-Key длиной 8–128 символов. Повтор с тем же ключом и телом возвращает ту же операцию; другое тело даёт 409. HTTP 202 означает постановку в очередь. Проверяйте состояние операции, а не факт получения ответа.

Авторизация и области доступа · Ошибки и повторы

Запрос

curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}'

Параметры

mailbox_idpathОбязательно

integer

X-Customer-IDheader

Вариант 1

string

Вариант 2

null

Idempotency-KeyheaderОбязательно

string

minLength: 8

maxLength: 128

Тело запроса · application/json

object

toОбязательно

array

Адреса основных получателей.

minItems: 1

maxItems: 50

Элементы массива

string

cc

array

Адреса получателей копии, видимые другим участникам.

maxItems: 50

Элементы массива

string

bcc

array

Адреса получателей скрытой копии.

maxItems: 50

Элементы массива

string

subject

string

Тема письма.

По умолчанию: ""

maxLength: 998

text

string

Текст письма без форматирования.

По умолчанию: ""

maxLength: 200000

html

HTML-версия письма с форматированием.

Вариант 1

string

maxLength: 300000

Вариант 2

null

file_ids

array

ID ранее загруженных файлов этого ящика. Получите их при загрузке или из списка файлов.

maxItems: 20

Элементы массива

string · uuid

forward_message

Исходное письмо, вложения которого нужно переслать.

Вариант 1

object

folderОбязательно

string

Имя папки из списка папок, например INBOX.

minLength: 1

maxLength: 255

uidvalidityОбязательно

integer

Значение uidvalidity из ответа API для этой папки.

exclusiveMinimum: 0

uidОбязательно

integer

exclusiveMinimum: 0

Неизвестные поля не принимаются.

Вариант 2

null

reply_to_message_id

Значение message_id письма, на которое вы отвечаете.

Вариант 1

string

maxLength: 998

Вариант 2

null

references

Значение references исходного письма для сохранения цепочки ответов.

Вариант 1

string

maxLength: 4000

Вариант 2

null

send_at

Время отложенной отправки с часовым поясом, например 2026-11-01T12:00:00Z. Без значения отправка начинается по мере обработки очереди.

Вариант 1

string · date-time

Вариант 2

null

Неизвестные поля не принимаются.

Ответы

202 Успешный ответ

application/json

object

id

string · uuid

Идентификатор операции для проверки состояния и отмены ожидающей отправки.

kind

string

mailbox_id

Вариант 1

integer

Вариант 2

null

status

string

Допустимые значения: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

created_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

completed_at

Вариант 1

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

Вариант 2

null

error

Причина ошибки, если операция не завершилась успешно.

Вариант 1

string

Вариант 2

null

result

Результат выполнения операции. Для отправки содержит сведения о принятых и отклонённых получателях.

Вариант 1

object

Вариант 2

null

400 Некорректный заголовок или идентификатор

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

401 Требуется вход

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Нет доступа

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ресурс не найден

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

409 Конфликт состояния

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

413 Превышен размер

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка валидации

application/json

object

detail

array

Элементы массива

object

locОбязательно

array

Элементы массива

Вариант 1

string

Вариант 2

integer

msgОбязательно

string

typeОбязательно

string

503 Временная недоступность

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

Результат успешной отправки

Поля result операции после исполнения, а не ответ на постановку в очередь.

object

message_id

string

smtp_accepted

boolean

sent_saved

boolean

accepted_recipients

array

Элементы массива

string

rejected_recipients

array

Элементы массива

object

email

string

code

integer