ПлимаДокументацияВ кабинет

Отправка писем

Очередь отправки, квитанции, идемпотентность и срок начала передачи письма.

POST /v1/emails

Нужны права emails:send. Отправитель и имя берутся из привязанного ящика. Один запрос адресован одному получателю.

Authorization: Bearer <PLIMA_API_KEY>
Content-Type: application/json
Idempotency-Key: registration-1842-code-1

{
  "to": "user@example.org",
  "subject": "Подтверждение регистрации",
  "text": "Ваш код: 123456",
  "html": "<p>Ваш код: <strong>123456</strong></p>",
  "expiresInSeconds": 300
}
to
Один email получателя.
subject
Обязательная строка, до 500 символов, без управляющих символов.
text, html
Нужна хотя бы одна строка. Общий размер до 128 КиБ.
expiresInSeconds
От 30 до 86400, по умолчанию 3600. Ограничивает начало передачи нашему SMTP.

Вложения, CC/BCC, произвольные заголовки и адрес From в запросе не поддерживаются. HTML передаётся строкой, загрузка по URL не выполняется.

Успешная постановка возвращает 202:

{
  "id": "EMAIL_ID",
  "status": "queued",
  "createdAt": "2026-11-04T09:30:00Z",
  "updatedAt": "2026-11-04T09:30:00Z",
  "expiresAt": "2026-11-04T09:35:00Z",
  "errorCode": null,
  "sentCopy": null,
  "replayed": false
}

Защита от повторов

Обязательный Idempotency-Key: от 8 до 128 символов A-Z a-z 0-9 . _ : -. Один ключ обозначает одну логическую отправку в пределах интеграции.

  • Повтор того же нормализованного тела: 200, прежний id, replayed: true. Новое письмо не создаётся.
  • Тот же ключ и другое содержимое: 409 idempotency_conflict.
  • Срок хранения идемпотентности и журнала: 30 дней. Старые идентификаторы не переиспользуйте.

GET /v1/emails/{id}

Право emails:status, тот же ключ интеграции. Возвращается квитанция, а не содержимое письма. Для почтового ящика используйте API чтения.

СтатусЗначение
queuedСохранено в очереди.
sendingНачата передача почтовому серверу.
acceptedSMTP Плимы принял письмо. Внешняя доставка не подтверждена.
failedПолучен определённый отказ.
unknownРезультат неизвестен. Автоматической повторной отправки нет.
expiredИстёк срок начала отправки.
cancelledКлюч отозван до начала отправки.

Поле sentCopy относится только к копии в «Отправленных». Ошибка копии не вызывает повторную отправку. Лимиты и ошибки.