Документация

API Reference

Базовый URL: https://api.mail.synapsea.agency. Аутентификация: Authorization: Bearer sm_live_....

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

POST/v1/emails

Отправить одно письмо.

Body:

json
{
  "from": "noreply@example.ru",
  "to": "user@example.com",
  "subject": "Subject",
  "html": "<p>Body</p>",
  "text": "Body",
  "cc": ["cc@example.com"],
  "bcc": ["bcc@example.com"],
  "replyTo": "reply@example.ru",
  "tags": ["onboarding", "welcome"],
  "headers": { "X-Custom-Header": "value" }
}

Response (202):

json
{ "id": "em_a1b2c3d4...", "status": "queued" }
POST/v1/emails/batch

Отправить до 100 писем за один запрос.

GET/v1/emails/:id

Получить детали письма и его события доставки.

Управление доменами

GET/v1/domains

Список подтверждённых доменов проекта.

POST/v1/domains

Добавить домен (возвращает DNS-записи для добавления).

POST/v1/domains/:id/verify

Проверить DNS-записи и подтвердить домен.

DELETE/v1/domains/:id

Удалить домен.

Suppression list

GET/v1/suppressions

Получить адреса в стоп-листе.

DELETE/v1/suppressions/:id

Удалить адрес из стоп-листа.

Аналитика

GET/v1/analytics/overview

Агрегированные метрики за сегодня/неделю/месяц.

GET/v1/analytics/timeseries

Посуточная статистика за 30 дней.

Rate limits

По умолчанию: 60 запросов/сек на проект для HTTP API, 300 писем/сек через SMTP. При превышении — HTTP 429. Увеличение лимитов на тарифах Pro и Scale — по запросу.

Ошибки

Все ошибки возвращаются в формате:

json
{ "error": "Описание ошибки" }

Коды:

  • 400 — невалидный payload
  • 401 — нет/неверный API-ключ
  • 403 — домен не подтверждён
  • 429 — превышен rate limit
  • 500 — внутренняя ошибка

Свежий список всех эндпоинтов и примеры запросов/ответов доступен в dashboard после входа.