Справочник API

Черновики и вложения

Создавайте сценарии написания писем с приватным хранилищем вложений.

POST/drafts
API-ключ

Создать черновик письма

Создать черновик письма

Запрос
curl https://sendhq.cc/api/v1/drafts \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Hello"}'
Ответ 201
{
  "id": "dr_…",
  "attachments": []
}
GET/drafts
API-ключ

Список черновиков

Список черновиков

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

Получить черновик и вложения

Получить черновик и вложения

Запрос
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "id": "dr_…",
  "attachments": []
}
PUT/drafts/:id
API-ключ

Заменить содержимое черновика

Заменить содержимое черновика

Запрос
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","to":["customer@example.net"],"subject":"Updated subject","text":"Updated body"}'
Ответ 200
{
  "id": "dr_…"
}
DELETE/drafts/:id
API-ключ

Удалить черновик

Удалить черновик

Запрос
curl https://sendhq.cc/api/v1/drafts/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "ok": true
}
POST/drafts/:id/attachments
API-ключ

Загрузить вложение в черновик

Загружает исходные байты файла. Укажите Content-Type и X-Filename. Письмо может содержать не более 10 файлов общим объёмом не более 10 МБ.

Необязательные заголовкиX-Filename
Запрос
curl https://sendhq.cc/api/v1/drafts/id_value/attachments \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/pdf" \
  -H "X-Filename: invoice.pdf" \
  --data-binary @invoice.pdf
Ответ 201
{
  "id": "att_…",
  "filename": "invoice.pdf",
  "sizeBytes": 48231,
  "available": true
}
GET/attachments/:id
API-ключ

Скачать приватное вложение

Скачать приватное вложение

Запрос
curl https://sendhq.cc/api/v1/attachments/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
DELETE/attachments/:id
API-ключ

Удалить приватное вложение

Удалить приватное вложение

Запрос
curl https://sendhq.cc/api/v1/attachments/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "ok": true
}
GET/sending-identities
API-ключ

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

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

Запрос
curl https://sendhq.cc/api/v1/sending-identities \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "domains": [],
  "addresses": [],
  "localParts": []
}