Справочник API

Письма и цепочки

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

Фильтр операций с письмами и цепочками

POST/emails

API-ключ

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

Отправляет транзакционное письмо с HTML, текстом или содержимым хранимого шаблона с подтверждённого домена рабочего пространства. При прямой отправке можно указать message_class со значением marketing, если это включено для подтверждённого домена отправителя. Для маркетинговых писем добавляются управляемые заголовки отписки, если только настроенная собственная интеграция не передаёт свой видимый HTTPS-адрес для отписки в один клик.

Необязательные заголовкиIdempotency-Key

Запрос

curl https://sendhq.cc/api/v1/emails \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'

Ответ 201

{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}

POST/emails/batch

API-ключ

Отправить до 100 индивидуальных писем

Необязательные заголовкиIdempotency-Key

Запрос

curl https://sendhq.cc/api/v1/emails/batch \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'

Ответ 201

{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}

GET/emails

API-ключ

Список отправленных и полученных писем

Список от новых к старым с фильтрами. `query` ищет по темам, текстам, участникам и именам файлов вложений. `label`, `domain` и `category` принимают одно значение или список через запятую (совпадение с любым); метки можно указывать по ID или по имени. `archived=false` возвращает представление «Входящие» для полученной почты. Полученные письма классифицируются как `primary`, `updates` (рассылки, массовые и автоматические письма) или `spam` и помечаются флагом `important`; спам исключается, если не указано `category=spam` или `include_spam=true`.

Параметры запросаdirectionstatusdomaininbox_idlabelarchivedcategoryimportantinclude_spamfromtounreadafterbeforequerylimitoffset

Запрос

curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "data": [],
  "count": 0
}

GET/emails/:id

API-ключ

Получить письмо и его вложения

Запрос

curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}

PATCH/emails/:id

API-ключ

Изменить статус прочтения, архивации, спама, категорию или важность

Задаёт `read`, `archived`, `category` (`primary`, `updates` или `spam` — только для полученных писем) и `important`. Изменение `category` или `important` обучает SendHQ в отношении отправителя: если пометить письмо как спам, будущие письма этого отправителя будут попадать в спам, отметка `Not spam` отменяет для него автоматические проверки на спам, а важность закрепляется за отправителем. Передайте `learn: false`, чтобы изменить только это письмо.

Запрос

curl https://sendhq.cc/api/v1/emails/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"spam"}'

Ответ 200

{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}

DELETE/emails/:id

API-ключ

Удалить сохранённое письмо

Запрос

curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "ok": true
}

GET/emails/:id/events

API-ключ

Список событий доставки письма

Запрос

curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "data": [],
  "count": 0
}

GET/threads/:id

API-ключ

Получить переписку в хронологическом порядке

Запрос

curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "id": "em_…",
  "data": [],
  "count": 0
}