Справочник API

Единый контракт для всех клиентских возможностей.

Клиентские эндпоинты доступны по пути /api/v1. Устаревший префикс /api по-прежнему доступен панели управления, но новые серверные интеграции должны использовать базовый URL с версией.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

Границы аутентификации

Интеграции с продуктом используют API-ключ рабочего пространства, который также позволяет читать данные об использовании аккаунта, аналитику и метаданные API-ключей. Изменения оплаты, а также создание и отзыв API-ключей требуют HTTP-only сессии браузера и помечены соответствующим образом.

Ресурсы

10 operations

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

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

8 операций

Метки и правила сортировки

Раскладывайте отправленные и полученные письма по папкам автоматически или вручную.

9 операций

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

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

10 операций

Хранимые шаблоны

Черновики, рендеринг, тесты, версии, публикация и отправка повторно используемого контента.

7 операций

Домены

Создавайте адреса отправителя и отслеживайте состояние подтверждения DNS.

8 операций

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

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

9 operations

Доставляемость

Просматривайте события, итоги репутации и заблокированных получателей.

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

Аккаунт и оплата

Чтение данных об использовании аккаунта, аналитики и метаданных ключей по API-ключу; изменения оплаты, создание и отзыв ключей требуют сессии панели управления.

Обёртка ошибок

JSON-ошибки используют одну предсказуемую обёртку. Коды состояния различают некорректный ввод, аутентификацию, отсутствующие ресурсы, конфликты, требования оплаты, блокировки безопасности и лимиты использования.

Ответ с ошибкой
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Версионирование

Этот контракт идентифицируется версией API на основе даты. В рамках версии могут добавляться обратно совместимые поля. Несовместимые изменения требуют нового базового пути с версией и задокументированного перехода.

Обнаружение
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}