Справочник API

Отправка email

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Обзор

Конечная точкаhttps://api.unbox.im/v1/email
МетодPOST
Content-Typeapplication/json
Область действияОдин API-ключ на пользовательский домен

Создавайте ключи в разделе Аккаунт → Домены → ваш домен → API после завершения проверки DNS. Полный секрет показывается только один раз — сохраните его в надежном месте. Дополнительные учетные данные SMTP на той же панели доменов также подчиняются правилам только транзакционных писем.

Только транзакционные письма

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Разрешенное использование

  • Подтверждение аккаунта, сброс пароля и оповещения безопасности
  • Подтверждения заказов, квитанции, обновления доставки и уведомления об оплате
  • Уведомления, вызванные конкретным действием пользователя или системным событием
  • Сообщения команды и рабочего пространства (приглашения, назначения, внутренние оповещения)

Запрещенное использование

  • Рассылки, рекламные кампании или массовый маркетинг
  • Холодные рассылки или письма на купленные, собранные или не давшие согласие списки
  • Партнерский спам, фишинг или вводящий в заблуждение контент
  • Любые попытки обойти ограничения на получателей, лимиты скорости или квоты тарифа

Лимиты скорости и получателей

Для защиты получателей и доставляемости исходящий API и SMTP трафик подчиняется указанным ниже лимитам (в дополнение к месячной исходящей квоте вашего тарифа). Контроль действует в веб-редакторе, HTTP API и SMTP-отправке. Веб-редактор предупреждает после 25 получателей на одно сообщение и блокирует отправку более 50.

ЛимитЗначение
Получателей на сообщениеДо 50 всего (Кому + Копия + Скрытая копия вместе)
Уникальных получателей в деньДо 1 000 на рабочее пространство
Частота запросов на отправкуДо 10 запросов через API или SMTP в минуту на домен
Исходящая квота тарифаМесячные лимиты отправки по вашей подписке остаются в силе

Эти правила являются частью нашей Политики допустимого использования. Автоматический контроль действует в веб-редакторе, HTTP API и SMTP-отправке. Аккаунты, рассылающие маркетинговые или массовые письма или иным образом злоупотребляющие инфраструктурой отправки, могут быть ограничены, приостановлены или удалены.

Мы отслеживаем сигналы доставляемости. Устойчивый уровень отказов выше 3% или жалоб выше 0,1% может привести к временной приостановке отправки или ручной проверке.

Ознакомьтесь с нашими Условиями предоставления услуг, Политикой конфиденциальности и Заявлением о GDPR для получения полной информации о политике.

Аутентификация

Отправляйте API-ключ вашего домена в каждом запросе:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Альтернативно используйте X-Api-Key: ubk_live_…. Ключи хранятся в хешированном виде; отзовите или обновите их на панели доменов.

Тело запроса

JSON с именами полей в PascalCase (From, To, …). Также принимаются псевдонимы в camelCase.

ПолеОбязательноОписание
FromДаОтправитель — ваш личный почтовый ящик в домене ключа (основной или псевдоним). Общие очереди не являются допустимыми отправителями.
ToДаПолучатель(и) — строка, строка через запятую или массив
SubjectДаТема письма
TextBodyОдно из TextBody / HtmlBodyТекстовое тело (простой текст)
HtmlBodyОдно из TextBody / HtmlBodyHTML тело
CcНетКопия получателям
BccНетСкрытая копия получателям
ReplyToНетАдрес для ответа (Reply-To)
TagНетНеобязательный тег метаданных (сохраняется вместе с отправкой)

Пример

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

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

HTTP 200 с JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Ответы об ошибках

Ошибки возвращают 4xx (или 500 для неожиданных сбоев) с JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Код ошибкиЗначение
0Успех
10Отсутствует API-ключ
11Недействительный или отозванный ключ, или домен не подтверждён для отправки
300Ошибка валидации (отсутствуют поля, неверный JSON и т.д.)
403Адрес отправителя не разрешён — должен быть вашим личным почтовым ящиком в домене ключа
406SES отклонил сообщение

Примеры

Замените you@yourdomain.com на ваш личный почтовый ящик в домене и используйте свой собственный API-ключ.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Начало работы

  1. Создайте аккаунт Unbox и добавьте ваш собственный домен.
  2. Выполните все шаги проверки DNS в разделе «Домены».
  3. Откройте «Домены» → ваш домен → API и сгенерируйте ключ домена.
  4. Отправьте ваше первое сообщение с помощью примеров выше.
Unbox — Документация API | Unbox.im