Справочник API

Входящая почта

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

POST/domains/:id/inbound/setup
API-ключ

Настроить приём входящей почты в SES

Настроить приём входящей почты в SES

Запрос
curl https://sendhq.cc/api/v1/domains/id_value/inbound/setup \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "domain": "inbound.example.com",
  "status": "dns_pending",
  "record": {
    "type": "MX",
    "name": "inbound.example.com",
    "value": "10 inbound-smtp.us-east-1.amazonaws.com"
  }
}
POST/domains/:id/inbound/verify
API-ключ

Проверить маршрутизацию входящей почты через MX

Проверить маршрутизацию входящей почты через MX

Запрос
curl https://sendhq.cc/api/v1/domains/id_value/inbound/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "domain": "inbound.example.com",
  "status": "ready",
  "record": {
    "type": "MX"
  }
}
POST/inboxes
API-ключ

Создать адрес для входящей почты

Создать адрес для входящей почты

Запрос
curl https://sendhq.cc/api/v1/inboxes \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_id":"dom_…","local_part":"support","name":"Support"}'
Ответ 201
{
  "id": "inb_…",
  "address": "support@inbound.example.com",
  "status": "active"
}
GET/inboxes
API-ключ

Список адресов для входящей почты

Список адресов для входящей почты

Параметры запросаdomain_id
Запрос
curl https://sendhq.cc/api/v1/inboxes \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "data": [],
  "count": 0
}
GET/inboxes/:id
API-ключ

Получить адрес для входящей почты

Получить адрес для входящей почты

Запрос
curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "id": "inb_…",
  "address": "support@example.com",
  "status": "active"
}
PATCH/inboxes/:id
API-ключ

Переименовать, включить или отключить почтовый ящик

Переименовать, включить или отключить почтовый ящик

Запрос
curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Customer support","status":"active"}'
Ответ 200
{
  "id": "inb_…",
  "status": "active"
}
PUT/inboxes/:id/forwarding
API-ключ

Пересылать полученную почту ящика на другой адрес

Задайте в `forward_to` email-адрес или null, чтобы отключить пересылку. Собственный адрес владельца аккаунта активируется сразу; на любой другой адрес приходит письмо с подтверждением (оно отправляется с подтверждённого домена ящика и учитывается как один получатель), и пересылка остаётся в ожидании, пока ссылка не будет подтверждена. Пересланные копии отправляются с адреса ящика, с исходным отправителем в Reply-To, учитывают стоп-лист и лимиты тарифа и никогда не пересылаются повторно.

Запрос
curl https://sendhq.cc/api/v1/inboxes/id_value/forwarding \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"forward_to":"team@example.net"}'
Ответ 200
{
  "id": "inb_…",
  "address": "support@example.com",
  "forwardTo": "team@example.net",
  "forwardStatus": "pending"
}
DELETE/inboxes/:id
API-ключ

Удалить почтовый ящик, сохранив письма

Удалить почтовый ящик, сохранив письма

Запрос
curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "ok": true
}