Справочник API
Аккаунт и оплата
Чтение данных об использовании аккаунта, аналитики и метаданных ключей по API-ключу; изменения оплаты, создание и отзыв ключей требуют сессии панели управления.
Нет операций, подходящих под этот фильтр.
/accountПолучить аккаунт, использование, состояние оплаты и число рабочих пространств по API-ключу
Аналог профиля в панели управления для API-ключа: владелец аккаунта, использование получателей и вложений за текущий период относительно лимитов тарифа, уровень доступа, сводка репутации отправителя, состояние подписки, опубликованные тарифы и число рабочих пространств. Только чтение; изменения оплаты по-прежнему доступны только в сессии.
curl https://sendhq.cc/api/v1/account \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"infrastructure": {},
"billing": {},
"plans": [],
"workspace": {
"mailer": "ses",
"stats": {}
}
}/account/diagnosticsDiagnose sending and receiving problems in the workspace
Read-only troubleshooting snapshot from stored state: an `issues` list in plain language, plan and usage against limits, each domain's DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, the last 30 days of messages that were not sent with their reasons, bounce, complaint and reject events, and webhook delivery health. Never returns message bodies, API keys or webhook secrets.
curl https://sendhq.cc/api/v1/account/diagnostics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"generatedAt": "2026-10-30T12:00:00.000Z",
"windowDays": 30,
"issues": [
{
"severity": "action",
"code": "domain_unverified",
"message": "example.com is not verified (pending); 2 of 3 DKIM records are not visible in DNS yet."
}
],
"plan": {},
"domains": [],
"sendingIdentities": {
"domains": [],
"addresses": []
},
"inbound": {},
"deliverability": {},
"suppressions": {},
"failures": {
"notSent": [],
"recentNotSent": [],
"recentProviderEvents": []
},
"webhooks": []
}/analyticsПолучить аналитику отправки из панели управления за 7, 30 или 90 дней
Итоги за период по отправленным, полученным, доставленным письмам, отказам, блокировкам, открытиям, кликам и жалобам, ежедневная шкала отправленных/полученных, основные домены отправки и самые результативные темы писем.
curl https://sendhq.cc/api/v1/analytics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"window": "30d",
"days": 30,
"metrics": {
"sent": 0,
"received": 0,
"bounced": 0,
"blocked": 0,
"delivered": 0,
"opened": 0,
"clicks": 0,
"complaints": 0
},
"timeline": [],
"domains": [],
"topContent": []
}/profileПолучить аккаунт, использование и состояние совмещённых подписок
Получить аккаунт, использование и состояние совмещённых подписок
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutНачать оформление оплаты на стороне провайдера для тарифа, который ещё не подключён (уровень, класс писем и период оплаты)
Начать оформление оплаты на стороне провайдера для тарифа, который ещё не подключён (уровень, класс писем и период оплаты)
curl https://sendhq.cc/api/v1/billing/checkout \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"plan_key":"scaleup_marketing_annual"}'{
"url": "https://checkout.example/…",
"session_id": "…"
}/billing/cancelОтменить текущую подписку в приложении, не обращаясь к провайдеру
Отменить текущую подписку в приложении, не обращаясь к провайдеру
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysСоздать API-ключ
Создать API-ключ
curl https://sendhq.cc/api/v1/keys \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'{
"id": "key_…",
"name": "Production",
"key": "re_…",
"prefix": "re_…"
}/keysСписок метаданных API-ключей
Возвращает имена ключей, несекретные префиксы и время последнего использования. Полные значения ключей никогда не возвращаются. Создание и отзыв ключей требуют сессии панели управления.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idОтозвать API-ключ
Отозвать API-ключ
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}