Для ИИ-агентов

MCP-сервер SendHQ

Give an AI agent full, safe control of one SendHQ workspace: send and receive email, verify domains, publish templates, and investigate deliverability through 142 strictly typed tools. Written for agents first; humans welcome.

142 toolsstdio transport, one command0 key-management tools
Установка и подключение (Claude Code)
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp

Что это за сервер

The SendHQ MCP server lets an AI agent operate one SendHQ workspace through the Model Context Protocol: send email (single, batch, templated, replies, attachments, idempotent retries), read and search sent and received mail (subjects, bodies, and attachment names) and its delivery events, organize mail into labels with auto-filing rules, manage drafts and private attachments, author and publish hosted templates, add and verify domains and their DNS, set up inbound receiving and inbound addresses, inspect deliverability, bounces, complaints, and suppressions, run newsletters (consented contacts with tags and custom fields, segments, lists with signup forms, welcome emails, and newsletter sites, and broadcasts with pre-send checks, test sends, scheduling, and bot-filtered open and click reports), and read account usage, billing state, analytics, and API-key metadata.

Это локальный stdio-сервер, встроенный в CLI-бинарник sendhq. Ваш MCP-клиент запускает sendhq mcp как дочерний процесс и общается с ним по JSON-RPC через stdin/stdout. Каждый вызов инструмента превращается в один документированный запрос к REST API SendHQ по адресу https://sendhq.cc/api/v1, аутентифицированный API-ключом вашего рабочего пространства, поэтому у MCP-сервера ровно те же права, что и у этого ключа, и не больше.

  • 142 tools in 10 groups, generated from one catalog that is also published as tools.json.
  • Строгие JSON Schema: неизвестные аргументы, неверные типы и отсутствующие обязательные поля отклоняются локально, до того как что-либо попадёт в SendHQ.
  • Структурированные ошибки со стабильным code, HTTP-статусом status, пояснением explanation, конкретным способом исправления remedy и признаком того, поможет ли повторная попытка.
  • Каждый инструмент, который отправляет реальные письма или удаляет данные, сообщает об этом в первых словах своего описания и снабжён аннотациями безопасности MCP.
  • Режим --read-only скрывает все инструменты, которые отправляют письма или что-либо изменяют.
  • Ничего не логируется. В stdout передаются только сообщения протокола; API-ключ и содержимое писем никогда не попадают в логи.
Это не MCP-эндпоинт документации.SendHQ также размещает небольшой MCP-эндпоинт документации только для чтения по адресу https://sendhq.cc/api/mcp (поиск по ценам и документации, без доступа к аккаунту). Сервер, описанный на этой странице, — полноценный, с доступом к аккаунту; он работает локально или как размещённый коннектор, описанный ниже.

Use SendHQ in Claude, ChatGPT and Grok

Установка не нужна: SendHQ также запускает этот сервер как размещённый коннектор по адресу https://mcp.sendhq.cc/mcp с теми же инструментами. Вместо того чтобы вставлять ключ, вы входите в свой аккаунт SendHQ.

Claude

  1. Откройте Settings → Connectors и найдите SendHQ в каталоге или выберите Add custom connector и вставьте https://mcp.sendhq.cc/mcp.
  2. Нажмите Connect, войдите в SendHQ, проверьте запрашиваемый доступ и нажмите Allow.
  3. Попросите Claude проверить ваш почтовый ящик, отправить письмо с вашего подтверждённого домена или объяснить причину отказа.

ChatGPT

  1. Open Settings → Security and login and turn on Developer mode.
  2. Go to chatgpt.com/plugins, click Create MCP app, name it SendHQ and enter https://mcp.sendhq.cc/mcp.
  3. Sign in to SendHQ and click Allow, then pick SendHQ from the tools menu in a new chat.

Grok

  1. Go to grok.com/connectors, click New Connector, then Custom.
  2. Enter https://mcp.sendhq.cc/mcp, sign in to SendHQ and click Allow.

Muse by Meta

In Muse, open Connectors and search for SendHQ. Click Connect, sign in to SendHQ and click Allow.

Подтверждение действий и отключение

  • The request_feature tool sends a feature request to the SendHQ team with your account details, so we can follow up by email.
  • Инструменты, которые отправляют реальные письма или удаляют данные, помечены соответствующим образом. Будет ли ассистент сначала спрашивать вас, настраивается для каждого инструмента в самом ассистенте: в Claude выберите Needs approval для этих инструментов в разделе Settings → Connectors → SendHQ.
  • Коннектор получает собственный API-ключ, названный по имени ассистента (например, «Claude (AI connector)»). Удалите его в разделе API Keys, чтобы немедленно отключить коннектор.
  • Он не может создавать или отзывать API-ключи и менять настройки оплаты. Вложения отправляются и возвращаются в base64; доступа к локальным файлам нет.
  • Sending requires an active subscription. There is no free allowance, including mail to the account owner.

Вопросы: postmaster@sendhq.cc. Конфиденциальность: sendhq.cc/privacy.

Установка

Установите бинарник sendhq (Linux, macOS и Windows на x86-64 и arm64). Установщик проверяет контрольную сумму релиза и по умолчанию помещает бинарник в ~/.local/bin.

macOS и Linux
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
Windows PowerShell
irm https://downloads.sendhq.cc/install.ps1 | iex
Проверка установки
sendhq version
SENDHQ_API_KEY=re_your_key sendhq doctor

Создайте API-ключ в панели управления по адресу https://sendhq.cc/app#/keys. MCP-сервер не умеет создавать ключи. Сервер запускается одной командой:

Запуск stdio-сервера
SENDHQ_API_KEY=re_your_key sendhq mcp

Обычно вручную её запускать не нужно: это делает MCP-клиент. Если запустить её в терминале, она будет ждать JSON-RPC на stdin.

Настройка клиента

Claude Code

claude mcp add
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp

# read-only variant
claude mcp add sendhq-readonly --env SENDHQ_API_KEY=re_your_key -- sendhq mcp --read-only

Добавьте --scope user, чтобы сервер был доступен во всех проектах, или --scope project, чтобы записать его в .mcp.json проекта. Для общего .mcp.json берите ключ из переменной окружения, а не коммитьте его; Claude Code подставляет значения ${VAR} в .mcp.json.

.mcp.json
{
  "mcpServers": {
    "sendhq": {
      "command": "sendhq",
      "args": [
        "mcp"
      ],
      "env": {
        "SENDHQ_API_KEY": "${SENDHQ_API_KEY}"
      }
    }
  }
}

OpenAI Codex

~/.codex/config.toml
[mcp_servers.sendhq]
command = "sendhq"
args = ["mcp"]
env = { SENDHQ_API_KEY = "re_your_key" }

Или из командной строки: codex mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp.

Claude Desktop

Отредактируйте claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\) и перезапустите приложение. Десктопные приложения не наследуют PATH вашей оболочки, поэтому укажите абсолютный путь к бинарнику (which sendhq).

claude_desktop_config.json
{
  "mcpServers": {
    "sendhq": {
      "command": "/Users/you/.local/bin/sendhq",
      "args": [
        "mcp"
      ],
      "env": {
        "SENDHQ_API_KEY": "re_your_key"
      }
    }
  }
}

Любой другой MCP-клиент

Настройте stdio-сервер с командой sendhq, аргументами ["mcp"] (при необходимости "--read-only") и переменными окружения, перечисленными ниже. Сервер поддерживает версии протокола MCP 2024-11-05, 2025-03-26, 2025-06-18 и 2025-11-25 и реализует initialize, ping, tools/list и tools/call. Результаты инструментов содержат и текстовый JSON-блок, и structuredContent.

Простейшая проверка через stdio (передайте на вход sendhq mcp)
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"probe","version":"1"}}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_service_health","arguments":{}}}

Размещённого HTTP-транспорта для сервера с доступом к аккаунту нет. Удалённому MCP-эндпоинту с правом записи потребовался бы OAuth для каждого пользователя, которого SendHQ не предлагает; локальный бинарник хранит ключ на той машине, где он и так уже есть.

Переменные окружения и флаги

Переменная или флагОбязательнаНазначение
SENDHQ_API_KEYдаAPI-ключ рабочего пространства (re_…). Нужен всем инструментам, кроме get_service_health. Без него сервер всё равно запускается, но каждый вызов возвращает структурированную ошибку auth_error с объяснением, как это исправить.
SENDHQ_API_BASE_URLнетБазовый URL API. По умолчанию https://sendhq.cc/api/v1. Используйте только для локального или тестового (staging) развёртывания. SENDHQ_BASE_URL принимается как устаревший псевдоним.
SENDHQ_MCP_READ_ONLYнет1, true или yes работают как --read-only.
--read-onlyнетОткрывать только инструменты, которые не отправляют письма и не меняют состояние. Скрытые инструменты также отклоняются при вызове по имени.
SENDHQ_PROFILE / --profileнетИспользовать ключ, сохранённый командой sendhq auth login в хранилище ключей ОС, вместо SENDHQ_API_KEY. Если заданы оба, приоритет у переменной окружения.

Ключ передаётся только в заголовке Authorization: Bearer на настроенный базовый URL. Он никогда не выводится, не логируется, не повторяется в ошибках и не включается в результаты инструментов.

Модель безопасности для агентов

  • Sends real email. send_email, send_batch, send_template_test, send_broadcast, send_broadcast_test, schedule_broadcast (at the scheduled time), and send_broadcast_to_more deliver mail to real people and consume delivery credits. Their descriptions start with SENDS REAL EMAIL. Call them only when the user explicitly asked for that specific message to be sent, with the recipients, sender, and content confirmed.
  • Destructive. delete_email, delete_draft, delete_attachment, delete_domain, delete_inbox, remove_suppression, the campaign deletes (delete_contact, delete_list, remove_list_contact, delete_broadcast, cancel_broadcast, delete_segment, delete_contact_field), and bulk_update_contacts are marked destructiveHint: true and their descriptions start with DESTRUCTIVE. Confirm with the user first. remove_suppression weakens a safety block and is appropriate only when a human confirms the address works again.
  • Изменяет состояние. Создание и изменение черновиков, шаблонов, доменов и почтовых ящиков, публикация шаблонов и запуск проверки меняют рабочее пространство, но не отправляют писем.
  • Только чтение. Все остальные инструменты имеют readOnlyHint: true, и их можно свободно вызывать.
  • Этот сервер никогда не меняет DNS. add_domain возвращает записи, которые должен опубликовать человек; get_domain_connect_link возвращает URL согласия, который человек должен открыть и одобрить у своего DNS-провайдера.
  • Этот сервер никогда не меняет оплату. get_account только читает тариф, использование и состояние подписки.
  • Sending requires an active subscription. There is no free allowance. Every send, including a test and a send to the account owner's own address, returns subscription_required (402) until a plan is active. Lapsed, cancelled, and past-due subscriptions are refused the same way. The owner chooses a plan in the dashboard (Profile & Billing) or at https://sendhq.cc/pricing. Unpaid workspaces can still verify domains, create keys, and read the workspace.
  • Accepted is not delivered. A successful send returns an ID; delivery, bounce, and complaint evidence arrives later in list_email_events. Never claim inbox placement or that a person read a message. Broadcast opens are estimates: privacy proxies and security scanners load images on their own, and requests that look automated are counted apart (machine in get_broadcast_report).
  • Не переключайтесь на другой адрес From, чтобы обойти приостановку 423, и никогда не добавляйте повторно получателей, которые отписались или пожаловались.

API-ключи вне зоны действия сервера

Намеренно нет инструментов, которые создают, изменяют, ротируют, отзывают или удаляют API-ключи. Агент не должен выпускать или уничтожать учётные данные. list_api_keys возвращает только имена, несекретные префиксы и время последнего использования. Управление ключами остаётся в панели управления за человеком, вошедшим в аккаунт.

Сценарии работы

1. Первая отправка

  1. get_service_health подтверждает, что API доступен (работает без ключа).
  2. get_account shows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returns subscription_required.
  3. list_sending_identities перечисляет адреса From, которые можно использовать. Если список пуст, сначала пройдите сценарий подключения домена.
  4. Подтвердите с пользователем отправителя, получателя, тему и текст, затем вызовите send_email с idempotency_key.
  5. list_email_events с возвращённым id покажет delivery, bounce, complaint или reject, как только провайдер сообщит результат (обычно от нескольких секунд до минут).
Первая отправка
{
  "name": "send_email",
  "arguments": {
    "from": "Acme <hello@example.com>",
    "to": [
      "owner@example.com"
    ],
    "subject": "SendHQ is connected",
    "text": "It works.",
    "idempotency_key": "first-send-2026-09-26"
  }
}

2. Подтверждение домена от начала до конца

  1. add_domain with name: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).
  2. get_dns_provider с domain_id определяет авторитетного DNS-провайдера и возвращает точный относительный хост, который нужно указать для каждой записи у этого провайдера.
  3. If providers.domainConnect.available is true, get_domain_connect_link returns a consent URL. Give it to the human; nothing changes until they approve at the provider. Otherwise, give the human the records to publish. Never publish a second SPF record: merge SendHQ's SPF include (include:amazonses.com) into the existing v=spf1 value.
  4. verify_domain rechecks DNS and DKIM verification. Status moves through pending, checking, and propagating to verified. Poll verify_domain or get_domain every 30–60 seconds; DNS can take minutes to hours.
  5. Когда status становится verified, адреса домена появляются в list_sending_identities.

3. Отказы, жалобы и стоп-лист

  1. list_blocked_recipients возвращает все заблокированные адреса с причиной (bounce, complaint, unsubscribe) и сводным количеством.
  2. list_suppressions возвращает записи стоп-листа из-за жёстких отказов и жалоб; deliverability_stats даёт доли доставки, отказов и жалоб за 30 дней; list_sender_reputation показывает, какие адреса From ограничены или приостановлены.
  3. Отправка, среди получателей которой есть адрес из стоп-листа, завершается ошибкой 422 recipient_suppressed. Уберите этого получателя и отправьте снова.
  4. Вызывайте remove_suppression, только когда человек подтвердил, что ящик, давший отказ, теперь работает. Записи о жалобах в стоп-листе постоянны (409 complaint_suppression_locked).

4. Приём входящей почты

  1. Домен (часто поддомен, например inbound.example.com) должен быть подтверждён.
  2. setup_inbound настраивает приём и возвращает одну MX-запись. Её публикует человек.
  3. Вызывайте verify_inbound, пока status не станет ready.
  4. create_inbox с domain_id и local_part (например, support) создаёт support@inbound.example.com.
  5. Опрашивайте list_emails с direction: "in" и unread: true (при необходимости с inbox_id). Читайте письмо через get_email, переписку — через get_thread, вложения — через download_attachment, а обработанное письмо отмечайте через mark_email (read: true).
  6. Отвечайте в той же цепочке через send_email с reply_to_email_id; SendHQ сам выставит In-Reply-To, References и цепочку.

5. Вебхуки и уведомления о событиях

Webhooks push signed events to an endpoint a human configures in the dashboard or with the REST API (see /docs/webhooks): email events (email.sent, email.delivered, email.delivery_delayed, email.bounced, email.complained, email.failed, email.received), contact.unsubscribed when a recipient unsubscribes from a marketing or automation email, and, for automations, automation.entered, automation.converted, and automation.exited. There is no webhook tool, because endpoint responses carry signing secrets. An agent without a webhook polls instead: list_email_events for one message's outcome, list_emails with status (for example bounced) or after for recent changes, list_emails with direction: "in" and unread: true for new inbound mail, and list_blocked_recipients for new suppressions. Poll no more than about once a minute per question.

6. Диагностика сбоя доставки

  1. Найдите письмо: list_emails с direction: "out" и to или query либо get_email, если ID известен. status: failed означает, что SendHQ или провайдер отклонили письмо при передаче; причина указана в ошибке письма.
  2. list_email_events: bounce (постоянный или временный, с диагностикой провайдера), complaint, reject или delivery. Если событий ещё нет, провайдер пока не сообщил результат; подождите и проверьте снова.
  3. If the send call itself failed, read the error code: subscription_required → the owner activates a plan; sender_domain_unverified → finish domain verification; recipient_suppressed → the address hard-bounced or complained before; sender_paused → inspect list_sender_reputation; account_paused → the workspace is paused for review, read the rates; daily_limit_reached → wait until midnight UTC; quota_exhausted → get_account usage.
  4. get_domain проверяет, что DKIM, SPF и DMARC по-прежнему опубликованы; deliverability_stats показывает, касается ли проблема одного письма или это тенденция.
  5. Сообщайте то, что показывают факты. Событие delivery означает, что сервер получателя принял письмо, а не что оно попало во «Входящие» или было прочитано.

7. Собственная группа для задач (метки)

  1. create_label с name (например, Agent/Orders) и skip_inbox: true. Это превращает метку в группу: полученные письма с этой меткой архивируются, поэтому отображаются только в метке и никогда — во «Входящих» человека.
  2. Отправляйте письма по задачам через send_email (или send_batch) с labels: ["Agent/Orders"]. Ответы в этой переписке автоматически наследуют метку и минуют «Входящие».
  3. Для писем, которые начинаются вне ваших переписок, добавьте правило сортировки: create_label_rule с inbox_id (выделенный адрес, например orders@…), from, to или subject. Передайте apply_to_existing: true, чтобы разложить уже полученные письма.
  4. Работа с группой: list_emails с label: "Agent/Orders", direction: "in" и unread: true; читайте через get_email или get_thread, отвечайте через send_email с reply_to_email_id, а после обработки вызывайте mark_email с read: true.
  5. Чтобы переместить случайно попавшее не туда письмо в группу или из неё, используйте label_email (add / remove). Добавление метки группы к полученному письму также архивирует его.
  6. При необходимости set_inbox_forwarding отправляет копию всех писем, приходящих на адрес получения, в другой почтовый ящик (получатель сначала подтверждает это по email).
Отправка в группу
{
  "name": "send_email",
  "arguments": {
    "from": "Orders <orders@example.com>",
    "to": [
      "customer@example.net"
    ],
    "subject": "Order 1042: confirm delivery window",
    "text": "Reply with a time that works.",
    "labels": [
      "Agent/Orders"
    ],
    "idempotency_key": "order-1042-window"
  }
}

8. Вложения и шаблоны

На платном тарифе прикрепляйте до 10 файлов через attachments в send_email (для каждого нужен content_base64 или локальный file_path; filename по умолчанию — базовое имя файла). Для хранимых шаблонов: create_template → update_template_draft → render_template для предпросмотра на тестовых данных → send_template_test (отправляет одно реальное тестовое письмо) → publish_template, затем отправляйте через send_email или send_batch с template: {key, data} и ровно одним получателем в to.

9. Send a newsletter

  1. Audience: list_lists (or create_list with a signup form), and optionally preview_segment then create_segment to narrow it, for example to contacts tagged VIP who opened in the last 90 days. Add only people who asked for your email: every subscribed contact needs a consent_basis.
  2. get_newsletter_settings: if postalAddress is empty, ask the user for one and set it with update_newsletter_settings (marketing email needs it).
  3. create_broadcast with list_id, a verified from, subject, preview_text, content (markdown is simplest), and optionally audience (segment_id, limit, order: engaged).
  4. check_broadcast: fix every block item and tell the user about warn items. Then send_broadcast_test to the user's own address so they can look at it.
  5. Only when the user says to send: send_broadcast now (with an idempotency_key), or schedule_broadcast with scheduled_at (unschedule_broadcast to change it).
  6. Follow up with get_broadcast (delivery totals), get_broadcast_report (opens, clicks, links, inbox providers, against your average), and list_broadcast_recipients with activity. Report opens as estimates. With a limited audience, send_broadcast_to_more sends to the next people.
Draft a broadcast
{
  "name": "create_broadcast",
  "arguments": {
    "list_id": "lst_…",
    "from": "Acme <news@example.com>",
    "subject": "What shipped in October",
    "preview_text": "Three new features",
    "markdown": "Hi {{first_name | there}},\n\nHere is what shipped this month.",
    "audience": {
      "segment_id": "seg_…"
    }
  }
}

10. Run an automation

An automation is a timed sequence of emails that starts when a contact does something and stops when they convert. Automations are being enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled from every tool below.

  1. create_automation with a key, the entry event, exit_rules (the goal_event that counts as converting, or no_goal: true), a verified from_address, and steps, each due offset_seconds after the person entered. It starts as a draft and sends nothing. Every automation carries domain, the domain of its from_address; in a workspace that sends from several domains, list_automations and get_automations_overview take domain to show the automations of one of them.
  2. To let the user read it first: send_automation_test_email sends one email, and send_automation_test every email in order, to the account's own address only (never to a contact), with stand-in values for the merge tags. A test enrols nobody, is in no report, and works while the automation is still a draft. Both send real email, so only when the user asks. send_automation_test_email with dry_run: true returns the rendered email without sending anything.
  3. get_sending_limits shows how much automation email one person may get across every automation, and during which hours. Change them with update_sending_limits only when the user asks.
  4. To start from a ready-made email instead of writing one: list_automation_templates is the template library (welcome, onboarding tips, a nudge to finish setup, trial ending and trial ended, abandoned checkout, failed payment or dunning, receipt, upgrade at a usage limit, feature announcement, review request, feedback score, cancellation survey, and winback for retention), get_automation_template shows one with the email as this workspace would send it, and use_automation_template makes the draft automation with the emails, the suggested entry event and the suggested goal. Some templates come as a set that makes one automation: three onboarding tips, trial ending then trial ended, payment failed then a last notice. set_automation_step with template loads one template into an email of an automation that already exists.
  5. An email can also be built in the dashboard's drag-and-drop builder. get_automation shows such an email with editor design: its content is the builder's project, which only the builder writes, and its html is what is sent. Leave the project alone. To change the wording of a designed email, ask the user to open it in the dashboard; to replace it, send your own html with editor html.
  6. A template is finished except for what only the user knows, written as placeholders in square brackets: [First step], or [Link to plans] as a link's address. to_fill on the automation lists each one by email, and each workspace name the emails print that is blank. Ask the user for the real words and links, write them in with set_automation_step, and set product_name and sender_name with update_sending_limits. Never invent them. set_automation_status refuses to turn the automation on while anything is left (422 automation_not_ready, with a problems list that names each email and detail); test emails are allowed, so the user can read it first.
  7. Only when the user says to start: set_automation_status with status: "on".
  8. Record what people do with track_event (a new contact needs contact.consent_basis). The entry event starts the sequence, the goal event ends it as converted, and a dedupe_key makes a retry harmless. enroll_contact and exit_contact add or remove one person by hand.
  9. preview_automation shows, for everyone in the automation now, which email would go out if they were evaluated at this moment, or why not: nothing due until a time, held by a limit or the sending hours until a time, waiting behind a higher-priority automation, or skipped. It sends nothing and changes nothing.
  10. list_automations gives each automation's 30-day totals. An email that a limit holds back is not dropped: it goes out when the limit allows. When several emails of one automation are due at once, only the latest is sent.
  11. Results: get_automations_overview (every automation) and get_automation_report (one automation, with a row per email) give totals and a number for each day of a date range: people who entered, emails sent, delivered, opened, clicked, and converted. list_automation_people lists who did what (did: entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, or waiting), and get_automation_person gives one contact's history with every open and click. Automation emails are tracked like broadcasts: report opens and clicks as estimates, and note that automated requests are labelled machine and never counted.
Start from a template
{
  "name": "use_automation_template",
  "arguments": {
    "template_id": "payment-failed-notices",
    "from_name": "Dana from Acme",
    "from_address": "dana@example.com"
  }
}
Dry run
{
  "name": "preview_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Who clicked the first email
{
  "name": "list_automation_people",
  "arguments": {
    "automation_key": "checkout-recovery",
    "did": "clicked",
    "step": 1
  }
}

11. See what came in, and connect another system

Events reach SendHQ three ways: track_event from the workspace's own code, a connection (a secret address a payment provider or another system posts its webhooks to), and a spreadsheet uploaded in the dashboard. See /docs/events.

  1. list_events is the feed of everything recorded, newest first: who, what they did (also as plain words), when, where it came from, and which automations it started, ended, or converted. Filter by contact, by name, or by date. list_event_names lists the kinds of event seen in the last 30 days.
  2. list_connections shows each connection with its last delivery in plain words, and get_connection its last 50 deliveries: "Recorded 2 events", "Skipped: no email address", "Refused: bad signature". Start there when something a provider sent did not show up.
  3. Only when the user asks to connect a system: create_connection with kind stripe or dodo (mapped for you) or generic with a mapping. It returns the secret address once; give it to the user to paste into that system. From then on what arrives is recorded without anyone looking, and can start automations that send email.
  4. update_connection with enabled: false pauses a connection (its address answers 404); delete_connection removes it. The provider's signing secret and a replacement address are set by a person in the dashboard.
What one person did
{
  "name": "list_events",
  "arguments": {
    "contact": "ada@example.net"
  }
}

12. Check an email's content before it is sent

score_email reads a subject, the HTML and the plain text as they were written and returns a score from 0 to 100 with what to change, most points first. A plain email with no links and no images scores 100; a designed layout, links to another site than the sender's, link shorteners, images with few words, hidden text, capitals and very long HTML each take points off. Pass from so links can be compared with the sender's own domain. Nothing is stored or sent, and the footer and tracking SendHQ adds are not scored. The dashboard's email editor shows the same number for the same content. It looks at content only, so use it as a checklist: sender reputation, authentication and how recipients react decide more of where mail lands.

Score a draft
{
  "name": "score_email",
  "arguments": {
    "from": "hello@example.com",
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
  }
}

Результаты, пагинация и ошибки

Успешный вызов возвращает JSON-объект API в виде structuredContent и в виде текстового JSON-блока. Каждый инструмент list_* принимает limit (1–200, по умолчанию 50) и offset и добавляет объект pagination. Продолжайте вызывать с offset: pagination.next_offset, пока has_more равно true.

Постраничный результат
{
  "data": [
    "…"
  ],
  "count": 50,
  "pagination": {
    "offset": 0,
    "limit": 50,
    "returned": 50,
    "total": 180,
    "has_more": true,
    "next_offset": 50
  }
}

Неудачный вызов возвращает isError: true со структурированной ошибкой. Следуйте remedy, а не повторяйте вслепую; повторяйте, только если retryable равно true.

Структурированная ошибка инструмента
{
  "error": {
    "code": "subscription_required",
    "status": 402,
    "message": "Sending requires an active SendHQ subscription. Choose a plan to start sending.",
    "retryable": false,
    "explanation": "This workspace has no active paid subscription. SendHQ does not send any email, including to the account owner, until a plan is active.",
    "remedy": "Ask the account owner to choose a plan at https://sendhq.cc/pricing or in the dashboard (Profile & Billing). Do not retry until the subscription is active."
  }
}

Необязательные поля ошибки: request_id (сообщите его в поддержку), retry_after_seconds, problems (список нарушений схемы для invalid_arguments) и idempotent_replayed (см. раздел «Идемпотентность»).

Идемпотентность

send_email и send_batch принимают idempotency_key (не более 200 символов), который передаётся в заголовке Idempotency-Key. Создавайте один стабильный ключ на каждое логическое письмо, например invoice-4812-receipt.

  • При повторе нужно использовать тот же ключ И идентичное тело запроса. Тот же ключ с любым изменением (получатель, тема, текст, заголовок, данные шаблона, даже значения аргументов) возвращает 409 idempotency_conflict.
  • Тот же ключ, то же тело, исходный запрос завершён: SendHQ возвращает сохранённый результат без повторной отправки. Так можно безопасно повторить запрос после тайм-аута или network_error.
  • Тот же ключ, пока исходный запрос ещё выполняется: 409 idempotency_in_progress, можно повторить после короткого ожидания.
  • Для нового логического письма нужен новый ключ.
  • Сохранённые ошибки тоже воспроизводятся. Если первая попытка завершилась ошибкой, повтор с тем же ключом вернёт ту же ошибку с idempotent_replayed: true и retryable: false. Проверьте через list_emails (direction: out), что ничего не ушло, устраните причину и отправьте с новым ключом.
  • Сервер никогда сам не повторяет POST-запросы. Автоматически повторяются только GET-запросы на чтение (до 3 попыток при сетевых ошибках, 429 и 5xx).
  • send_email со встроенными attachments не принимает idempotency_key, потому что выполняет несколько запросов. Для безопасной с точки зрения повторов отправки вложений: create_draft → upload_attachment → send_email с draft_id и idempotency_key.
Безопасная отправка с повтором (при тайм-ауте повторите в точности)
{
  "name": "send_email",
  "arguments": {
    "from": "Acme <billing@example.com>",
    "to": [
      "owner@example.com"
    ],
    "subject": "Receipt #4812",
    "text": "Thanks for your payment.",
    "idempotency_key": "receipt-4812"
  }
}

Лимиты запросов и квоты

SendHQ не публикует фиксированный лимит запросов в секунду для API. На практике агент сталкивается с лимитами использования, которые возвращаются как 429:

  • Месячный лимит доставок получателям по тарифу. Каждый адрес в To, Cc и Bcc считается одной доставкой. См. get_account → usage.recipientDeliveries в сравнении с usage.emailQuotaMonth.
  • Дневной лимит получателей для конкретного адреса From, который задаётся состоянием репутации этого отправителя (list_sender_reputation → dailyLimit, по умолчанию 2 000 на платных тарифах).
  • Subscription: sending is refused with subscription_required until a paid plan is active. There is no free or trial allowance.
  • Workspace daily ladder on paid plans: 1,000 recipients on day one, then 2,000, 3,000, 5,000, 8,000, 12,000, 18,000, 25,000, 35,000, 45,000, and 50,000. A step is gained after a UTC day that used at least half the cap with healthy 7-day feedback. A high rate demotes once per incident, not every day the rate stays high. See get_account → sendingLimit. Over the cap: daily_limit_reached, not queued, retry after resets_at (midnight UTC), not on a short backoff.
  • Hourly pace: about one tenth of the day's cap each UTC hour (100 on day one). hourly_limit_reached waits until the next UTC hour.
  • New domains: a sending domain less than 30 days old may send at most 500 Gmail recipients a day (gmail_recipient_limit), on any ladder rung. gmail_rate_limited means Gmail returned 4.7.28; wait until resets_at and keep sending to other providers.
  • Вложения: не более 10 файлов и 10 МБ на письмо; 10 ГБ передачи вложений в месяц с учётом числа получателей на платных тарифах.
  • На один запрос: To + Cc + Bcc — до 100 адресов; send_batch — до 100 писем.
  • Репутационный предохранитель: если в скользящем 7-дневном окне отказы или жалобы превышают порог, отправка с конкретного адреса From ограничивается или приостанавливается (423 sender_paused). Когда показатели снижаются, адрес восстанавливается автоматически.

quota_exhausted нельзя повторять, пока не начнётся новый период или не сменится тариф. rate_limited можно повторить через retry_after_seconds; для отправок повторяйте с тем же idempotency_key и идентичным телом.

Каталог ошибок

code стабилен; ветвите логику по нему, а не по message.

codeHTTPПовторять?Что это значит и что делать
invalid_arguments—нетАргументы не прошли локальную проверку JSON Schema инструмента; в SendHQ ничего не отправлено. Исправьте поля, перечисленные в problems.
auth_error401нетAPI-ключ отсутствует, отозван или неверен. Задайте SENDHQ_API_KEY для процесса сервера; ключи создаёт человек в панели управления.
subscription_required402нетNo active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then.
payment_required402нетФункция требует платного тарифа (например, вложения). Отправьте без неё или перейдите на платный тариф.
sender_domain_not_owned403нетДомен From не относится к этому рабочему пространству. Используйте list_sending_identities или add_domain.
sender_domain_unverified403нетДомен From ещё не подтверждён. get_domain, опубликуйте недостающие записи, verify_domain.
domain_limit_reached403нетДостигнут лимит доменов по тарифу. Удалите неиспользуемый домен (с согласия человека) или перейдите на старший тариф.
marketing_not_enabled403нетМаркетинговый класс не включён для этого домена или тарифа. Используйте transactional, только если письмо действительно транзакционное.
forbidden403нетПолитика не разрешает эту операцию. Измените запрос.
not_found404нетЭтот ID не относится к рабочему пространству. Запросите список ресурсов, чтобы найти правильный ID; архивные шаблоны сначала восстановите.
idempotency_conflict409нетКлюч повторно использован с другим телом. Отправьте в точности исходный запрос или используйте новый ключ для нового письма.
idempotency_in_progress409даИсходный запрос ещё выполняется. Подождите, затем повторите с тем же ключом и телом.
revision_conflict409нетЧерновик шаблона изменился с момента чтения. get_template, объедините изменения, сохраните снова.
complaint_suppression_locked409нетПолучатель пожаловался. Никогда больше ему не пишите.
inbound_not_ready409нетПриём входящей почты не готов. setup_inbound, опубликуйте MX, verify_inbound.
conflict409нетРесурс уже существует или находится в неподходящем состоянии. Прочитайте его и скорректируйте запрос.
attachments_too_large413нетБольше 10 файлов или 10 МБ. Уберите или уменьшите вложения.
recipient_suppressed422нетПолучатель ранее дал жёсткий отказ или пожаловался. Уберите его; см. list_blocked_recipients.
recipient_unsubscribed422нетПолучатель отписался от маркетинговых писем. Уберите его навсегда.
validation_failed422нетСодержимое отклонено, например данные шаблона нарушают контракт переменных. Исправьте входные данные.
sender_paused423нетЭтот адрес From приостановлен 7-дневным предохранителем по отказам и жалобам. Остановитесь, исправьте список, дождитесь автоматического восстановления.
account_paused423нетWorkspace paused for a deliverability review. The body has the measured rate and the limit when the pause was for bounces or complaints. Do not send until it is restored.
quota_exhausted429нетMonthly allowance, per-sender daily limit, or attachment transfer. Not the workspace daily ladder. Check get_account; wait for that limit to reset or upgrade.
daily_limit_reached429after resetWorkspace daily ladder. Not a short backoff. Wait until resets_at (midnight UTC). The message was not queued.
hourly_limit_reached429after resetHourly pace (about a tenth of the day's cap). Wait until the next UTC hour. Not a short backoff.
gmail_recipient_limit429after reset500 Gmail recipients a day for a sending domain under 30 days old, on any ladder rung. Wait until midnight UTC. Not queued.
gmail_rate_limited429after resetGmail returned 4.7.28 for this domain. Wait until resets_at. Other providers keep sending.
rate_limited429даSlow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap.
server_error5xxдаВременный сбой SendHQ или провайдера. Сделайте паузу и повторите; отправки — с тем же ключом и телом. Если idempotent_replayed равно true, используйте новый ключ, убедившись, что ничего не было отправлено.
network_error—даЗапрос или ответ потерян. Повторите; для отправок безопасность повтора обеспечивает тот же idempotency_key.
invalid_request400нетНекорректный запрос. Прочитайте message и исправьте его.
tool_error—нетЛокальный сбой внутри MCP-сервера (например, нечитаемый file_path). Прочитайте message.

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

Все инструменты с классом безопасности, вызываемым REST-эндпоинтом, параметрами, форматом ответа и примером объекта параметров tools/call. Параметры указаны точно: сервер отклоняет всё, чего нет в списке.

Emails and threads: send_email, send_batch, list_emails, get_email, mark_email, delete_email, list_email_events, get_thread, email_delivery, thread_delivery
Labels and auto-filing rules: list_labels, get_label, create_label, update_label, delete_label, create_label_rule, delete_label_rule, label_email
Drafts, attachments, and sender identities: list_sending_identities, create_draft, list_drafts, get_draft, update_draft, delete_draft, upload_attachment, download_attachment, delete_attachment
Hosted templates: list_templates, create_template, get_template, update_template_draft, create_template_draft, render_template, send_template_test, publish_template, archive_template, restore_template
Domains and DNS: list_domains, get_domain, add_domain, verify_domain, delete_domain, get_dns_provider, get_domain_connect_link
Inbound email: setup_inbound, verify_inbound, list_inboxes, get_inbox, create_inbox, update_inbox, set_inbox_forwarding, delete_inbox
Deliverability, bounces, and suppressions: deliverability_stats, deliverability_account, deliverability_domains, deliverability_senders, score_email, list_sender_reputation, list_suppressions, remove_suppression, list_blocked_recipients
Campaigns: list_contacts, create_contact, upsert_contact, get_contact, update_contact, delete_contact, import_contacts, list_contact_imports, bulk_update_contacts, list_tags, list_contact_fields, set_contact_field, delete_contact_field, list_segments, get_segment, preview_segment, create_segment, update_segment, delete_segment, list_lists, create_list, get_list, update_list, delete_list, add_list_contacts, remove_list_contact, list_broadcasts, create_broadcast, get_broadcast, update_broadcast, delete_broadcast, send_broadcast, cancel_broadcast, list_broadcast_recipients, check_broadcast, send_broadcast_test, schedule_broadcast, unschedule_broadcast, duplicate_broadcast, send_broadcast_to_more, get_broadcast_report, get_newsletter_settings, update_newsletter_settings, get_campaign_overview, list_uploaded_images
Automations, events, and sending limits: track_event, list_automations, get_automation, create_automation, update_automation, delete_automation, set_automation_step, delete_automation_step, set_automation_step_variant, set_automation_status, send_automation_test_email, send_automation_test, enroll_contact, exit_contact, preview_automation, get_automations_overview, get_automation_report, list_automation_people, get_automation_person, get_sending_limits, update_sending_limits, list_automation_templates, get_automation_template, use_automation_template, list_events, list_event_names, list_connections, get_connection, create_connection, update_connection, delete_connection
Account, usage, analytics, and keys: get_account, get_account_diagnostics, get_analytics, list_api_keys, get_service_health

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

Отправляет реальные письмаsend_email
POST /emails

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

SENDS REAL EMAIL. Send one message from a verified domain: raw html/text, a published hosted template, a reply in an existing thread, or a message with attachments. Pass idempotency_key so a retry cannot send twice; a retry must reuse the same key AND an identical request, otherwise SendHQ returns 409. attachments is a convenience that creates a draft, uploads each file, and sends with that draft; it cannot be combined with idempotency_key or draft_id (use create_draft + upload_attachment + send_email with draft_id for retry-safe attachment sends). Unpaid workspaces (integration trial) can deliver only to the account email or a mailbox-simulator test address, and cannot send attachments.

Укажите хотя бы одно из: html, text, template.

ПараметрТипОбязательнаОписание
fromstringдаОтправитель, например Acme <hello@example.com>. Домен должен быть подтверждён в этом рабочем пространстве (см. list_sending_identities). (макс. 998 символов)
tostring[]даПолучатели. Каждый элемент — адрес, при необходимости с отображаемым именем. В сумме To+cc+bcc — не более 100; каждый адресат расходует один кредит на доставку. (1–100 элементов)
ccstring[]нетПолучатели копии. (0–100 элементов)
bccstring[]нетПолучатели скрытой копии. (0–100 элементов)
subjectstringнетТема письма. Не указывайте при отправке шаблона. (макс. 998 символов)
textstringнетТекстовая версия письма. Укажите text, html или template.
htmlstringнетHTML-версия письма. SendHQ очищает её и формирует текст, если text не указан.
reply_tostringнетАдрес Reply-To.
headersobjectнетДополнительные безопасные пользовательские заголовки (строковые значения), например {"X-Entity-Ref-ID": "123"}. Заголовками маршрутизации, такими как From/To/Message-ID, управляет SendHQ.
message_classstringнетtransactional (по умолчанию) или marketing. Для маркетинговых писем нужен тариф или домен с включённым маркетингом; добавляется обработка отписки. (одно из transactional, marketing)
reply_to_email_idstringнетОтвет внутри существующей переписки: ID вида em_… письма, на которое вы отвечаете. SendHQ выставляет In-Reply-To/References и цепочку.
thread_idstringнетЯвный ID цепочки, к которой относится письмо.
draft_idstringнетОтправить с этим письмом вложения сохранённого черновика (dr_…). После успешной отправки черновик удаляется.
templateobjectнетОтправить опубликованный хранимый шаблон вместо готового html/текста. Требуется ровно один получатель в to и никаких cc/bcc; тему задаёт шаблон. Укажите хотя бы одно из: id, key.
template.idstringнетID шаблона (tmpl_…). Укажите id или key.
template.keystringнетКлюч шаблона, например account-welcome. Укажите id или key.
template.version_idstringнетНеобязательный ID опубликованного релиза (tmplv_…). По умолчанию — текущий опубликованный релиз.
template.dataobjectнетЗначения типизированных переменных шаблона.
labelsstring[]нетИмена меток или ID вида lbl_…, под которыми сохранить письмо. Неизвестные имена создаются. Ответы в переписке наследуют метки, а метка группы (skip_inbox) не пускает эти ответы во «Входящие». Не более 10. (0–10 элементов)
idempotency_keystringнетЗаголовок Idempotency-Key (макс. 200 символов). Используйте его повторно, только чтобы повторить этот же запрос. (макс. 200 символов)
attachmentsobject[]нетФайлы для вложения (не более 10 файлов, 10 МБ в сумме). Для каждого нужен content_base64 (плюс filename) или локальный file_path. (0–10 элементов) Укажите хотя бы одно из: content_base64, file_path.
attachments[].filenamestringнетИмя файла, которое увидит получатель. Обязательно при content_base64; по умолчанию — базовое имя из file_path. (макс. 255 символов)
attachments[].content_typestringнетMIME-тип, например application/pdf. По умолчанию application/octet-stream.
attachments[].content_base64stringнетСодержимое файла в стандартном base64.
attachments[].file_pathstringнетАбсолютный путь к локальному файлу, доступному для чтения процессу MCP-сервера.
Возвращает{id: em_…, providerMessageId, threadId, templateId, templateVersionId, isTest}. Принято — не значит доставлено: проверьте результат через list_email_events.
Пример параметров tools/call
{
  "name": "send_email",
  "arguments": {
    "from": "Acme <hello@example.com>",
    "to": [
      "owner@example.com"
    ],
    "subject": "Your export is ready",
    "text": "Download it from your dashboard.",
    "idempotency_key": "export-ready-42"
  }
}
Отправляет реальные письмаsend_batch
POST /emails/batch

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

SENDS REAL EMAIL. Отправляет от 1 до 100 независимых писем одним запросом (используйте для персонализации шаблона под каждого получателя). Каждый элемент имеет ту же структуру, что и send_email (без attachments/idempotency_key). Элементы выполняются или завершаются ошибкой по отдельности: HTTP 207 означает частичный успех; проверяйте data[i].ok и data[i].error для каждого. Один idempotency_key покрывает всё тело пакета.

ПараметрТипОбязательнаОписание
emailsobject[]даПисьма для отправки. (1–100 элементов) Укажите хотя бы одно из: html, text, template.
idempotency_keystringнетIdempotency-Key для всего пакета (макс. 200 символов). (макс. 200 символов)
Возвращает{data: [{index, ok, id?, error?: {message, status}}], count, successful, failed}.
Пример параметров tools/call
{
  "name": "send_batch",
  "arguments": {
    "emails": [
      {
        "from": "Acme <hello@example.com>",
        "to": [
          "owner@example.com"
        ],
        "template": {
          "key": "account-welcome",
          "data": {
            "first_name": "Asha"
          }
        }
      }
    ],
    "idempotency_key": "welcome-batch-2026-09-26"
  }
}
Только чтениеlist_emails
GET /emails

Список писем и поиск

Список отправленных (direction: out) и полученных (direction: in) писем от новых к старым с фильтрами. Полученные письма классифицируются: чтобы читать «Входящие» человека, используйте direction: in, archived: false, category: primary; для приоритизации — important: true; спам скрыт, если не указано category: spam или include_spam: true. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
directionstringнетin — полученные, out — отправленные. (одно из in, out)
statusstringнетФильтр по статусу, например queued, sent, delivered, bounced, complained, failed.
domainstringнетТолько письма для этого домена или списка доменов через запятую (совпадение с любым).
inbox_idstringнетТолько письма, полученные этим почтовым ящиком (inb_…).
labelstringнетТолько письма с этой меткой: ID метки lbl_… или точное имя либо список через запятую (совпадение с любым). Папки можно посмотреть через list_labels.
archivedbooleanнетfalse — представление «Входящие» (полученные неархивные письма), true — только архивные. Не указывайте, чтобы получить все письма.
categorystringнетprimary (люди), updates (рассылки, массовые и автоматические письма) или spam; либо список через запятую. Спам скрыт, если его не запросить.
importantbooleanнетtrue — только письма, помеченные как важные (ответы на начатые вами переписки и письма от отправителей, отмеченных как важные).
include_spambooleanнетВключить спам в результаты (для поиска по всем папкам).
fromstringнетАдрес отправителя содержит это значение.
tostringнетАдрес получателя содержит это значение.
unreadbooleanнетtrue — только непрочитанные, false — только прочитанные.
afterstringнетМетка времени ISO-8601; только письма, созданные после неё. (date-time)
beforestringнетМетка времени ISO-8601; только письма, созданные до неё. (date-time)
querystringнетПолнотекстовый поиск по темам, текстам, адресам отправителей и получателей и именам файлов вложений. (макс. 200 символов)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [email summaries], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_emails",
  "arguments": {
    "direction": "in",
    "unread": true,
    "limit": 25
  }
}
Только чтениеget_email
GET /emails/:email_id

Получить одно письмо

Получает одно письмо с заголовками, html/текстом, статусом, метаданными цепочки и метаданными вложений (сами байты скачивайте через download_attachment).

ПараметрТипОбязательнаОписание
email_idstringдаID письма (начинается с em_), возвращённый инструментом списка или создания. (макс. 128 символов)
ВозвращаетОбъект письма: {id, direction, status, from, to, cc, bcc, subject, html, text, threadId, messageId, providerMessageId, readAt, createdAt, attachments: [{id, filename, contentType, sizeBytes, available}]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Изменяет состояниеmark_email
PATCH /emails/:email_id

Отметить как прочитанное, архивное, спам или важное

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

ПараметрТипОбязательнаОписание
email_idstringдаID письма (начинается с em_), возвращённый инструментом списка или создания. (макс. 128 символов)
readbooleanнетtrue — прочитано, false — не прочитано.
archivedbooleanнетtrue — архивировать (убрать из «Входящих»), false — вернуть во «Входящие».
categorystringнетПереместить полученное письмо в primary, updates или spam. (одно из primary, updates, spam)
importantbooleanнетПоставить или снять отметку важности.
learnbooleanнетfalse — не запоминать это решение для отправителя (по умолчанию true).
ВозвращаетОбновлённый объект письма.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "mark_email",
  "arguments": {
    "email_id": "em_123",
    "read": true
  }
}
Деструктивноdelete_email
DELETE /emails/:email_id

Удалить письмо

DESTRUCTIVE: безвозвратно удаляет сохранённое письмо и его вложения из SendHQ. Уже доставленное письмо при этом не отзывается.

ПараметрТипОбязательнаОписание
email_idstringдаID письма (начинается с em_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Только чтениеlist_email_events
GET /emails/:email_id/events

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

События провайдера для одного отправленного письма: delivery, bounce, complaint, reject, open, click. Это доказательство того, было ли письмо доставлено или почему произошёл сбой. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
email_idstringдаID письма (начинается с em_), возвращённый инструментом списка или создания. (макс. 128 символов)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{event_type, recipient, reason, created_at, …}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_email_events",
  "arguments": {
    "email_id": "em_123"
  }
}
Только чтениеget_thread
GET /threads/:thread_id

Получить переписку

Получает все письма переписки в хронологическом порядке (отправленные и полученные), каждое с метаданными вложений.

ПараметрТипОбязательнаОписание
thread_idstringдаID цепочки (обычно ID вида em_… первого письма; см. threadId у любого письма). (макс. 128 символов)
Возвращает{id, subject, data: [emails]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_thread",
  "arguments": {
    "thread_id": "em_123"
  }
}
Read-onlyemail_delivery
GET /emails/:email_id/delivery

Get an email delivery timeline

Queued, sent, delivered, delayed, bounced, complained, and failed events for one email, with bounce type and the SMTP diagnostic. Reasons are plain text.

ПараметрТипОбязательнаОписание
email_idstringда
limitintegerнет
offsetintegerнет
Returns{emailId, status, timeline, count, limit, offset}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "email_delivery",
  "arguments": {
    "email_id": "em_123"
  }
}
Read-onlythread_delivery
GET /threads/:thread_id/delivery

Get a thread delivery summary

Counts of delivered, bounced, complained, and failed outbound messages in one conversation, plus each message's failure reason.

ПараметрТипОбязательнаОписание
thread_idstringда
Returns{threadId, delivered, bounced, complained, failed, messages}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "thread_delivery",
  "arguments": {
    "thread_id": "thr_123"
  }
}

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

Только чтениеlist_labels
GET /labels

Список меток

Список меток (папок) рабочего пространства с общим числом писем, числом непрочитанных и правилами автосортировки. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{id, name, color, totalCount, unreadCount, rules: [...]}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_labels",
  "arguments": {}
}
Только чтениеget_label
GET /labels/:label_id

Получить метку

Получает одну метку со счётчиками и правилами автосортировки.

ПараметрТипОбязательнаОписание
label_idstringдаID метки (начинается с lbl_) или точное имя метки. (макс. 128 символов)
ВозвращаетОбъект метки.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_label",
  "arguments": {
    "label_id": "Billing"
  }
}
Изменяет состояниеcreate_label
POST /labels

Создать метку

Создаёт метку-папку. Укажите skip_inbox: true, чтобы сделать её группой, которой владеет агент: отправляйте с labels: [name], и ответы будут попадать в метку, минуя «Входящие». Необязательные правила автосортировки раскладывают новые отправленные и полученные письма (должны совпасть все условия правила). Укажите apply_to_existing, чтобы разложить и уже сохранённые письма.

ПараметрТипОбязательнаОписание
namestringдаИмя метки, например Billing или Clients/Acme. Уникально в рамках рабочего пространства (без учёта регистра). (макс. 64 символа)
colorstringнетЦвет в HEX, например #1a73e8. Необязательно.
skip_inboxbooleanнетРежим группы: полученные письма с этой меткой (по правилу, как ответ на переписку, отправленную с этой меткой, или вручную) архивируются и отображаются только в метке, а не во «Входящих».
rulesobject[]нетНеобязательные правила автосортировки (не более 20). Для каждого нужно хотя бы одно из: inbox_id, from, to, subject. (0–20 элементов)
rules[].directionstringнетТолько письма in (полученные) или out (отправленные). Не указывайте, чтобы учитывать оба направления. (одно из in, out)
rules[].inbox_idstringнетТолько письма, полученные этим почтовым ящиком (inb_…). Раскладывает письма каждого адреса получения в отдельную папку.
rules[].fromstringнетОтправитель содержит этот текст (без учёта регистра), например @stripe.com. (макс. 200 символов)
rules[].tostringнетTo/Cc содержит этот текст (без учёта регистра). (макс. 200 символов)
rules[].subjectstringнетТема содержит этот текст (без учёта регистра). (макс. 200 символов)
rules[].skip_inboxbooleanнетАрхивировать подходящие полученные письма, чтобы они отображались только в папке метки, а не во «Входящих».
apply_to_existingbooleanнетРазложить также уже сохранённые письма, подходящие под правила.
ВозвращаетСозданную метку с правилами.
Пример параметров tools/call
{
  "name": "create_label",
  "arguments": {
    "name": "Agent/Orders",
    "skip_inbox": true,
    "rules": [
      {
        "from": "@stripe.com"
      }
    ]
  }
}
Изменяет состояниеupdate_label
PATCH /labels/:label_id

Переименовать метку, изменить цвет или сделать группой

Переименовывает метку, меняет её цвет или включает/выключает режим группы (skip_inbox). При включении режима группы полученные письма, уже имеющие эту метку, архивируются.

ПараметрТипОбязательнаОписание
label_idstringдаID метки (начинается с lbl_) или точное имя метки. (макс. 128 символов)
namestringнетНовое имя. (макс. 64 символа)
colorstringнетНовый цвет в HEX.
skip_inboxbooleanнетРежим группы: полученные письма с этой меткой (по правилу, как ответ на переписку, отправленную с этой меткой, или вручную) архивируются и отображаются только в метке, а не во «Входящих».
ВозвращаетОбновлённую метку.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_label",
  "arguments": {
    "label_id": "lbl_123",
    "name": "Finance/Billing"
  }
}
Деструктивноdelete_label
DELETE /labels/:label_id

Удалить метку

DESTRUCTIVE: удаляет метку и её правила. Сами письма сохраняются; с них лишь снимается эта метка.

ПараметрТипОбязательнаОписание
label_idstringдаID метки (начинается с lbl_) или точное имя метки. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_label",
  "arguments": {
    "label_id": "lbl_123"
  }
}
Изменяет состояниеcreate_label_rule
POST /labels/:label_id/rules

Добавить правило автосортировки

Добавляет к метке правило, чтобы подходящие новые письма раскладывались автоматически. Должны совпасть все заданные условия. Используйте inbox_id, чтобы выделить адресу получения отдельную папку; добавьте skip_inbox, чтобы такие письма не попадали во «Входящие».

ПараметрТипОбязательнаОписание
label_idstringдаID метки (начинается с lbl_) или точное имя метки. (макс. 128 символов)
directionstringнетТолько письма in (полученные) или out (отправленные). Не указывайте, чтобы учитывать оба направления. (одно из in, out)
inbox_idstringнетТолько письма, полученные этим почтовым ящиком (inb_…). Раскладывает письма каждого адреса получения в отдельную папку.
fromstringнетОтправитель содержит этот текст (без учёта регистра), например @stripe.com. (макс. 200 символов)
tostringнетTo/Cc содержит этот текст (без учёта регистра). (макс. 200 символов)
subjectstringнетТема содержит этот текст (без учёта регистра). (макс. 200 символов)
skip_inboxbooleanнетАрхивировать подходящие полученные письма, чтобы они отображались только в папке метки, а не во «Входящих».
apply_to_existingbooleanнетРазложить также уже сохранённые подходящие письма.
Возвращает{id: lrule_…, labelId, direction, inboxId, from, to, subject, skipInbox}.
Пример параметров tools/call
{
  "name": "create_label_rule",
  "arguments": {
    "label_id": "Billing",
    "inbox_id": "inb_123",
    "skip_inbox": true
  }
}
Деструктивноdelete_label_rule
DELETE /labels/:label_id/rules/:rule_id

Удалить правило автосортировки

DESTRUCTIVE: удаляет одно правило автосортировки. Уже разложенные письма сохраняют метку.

ПараметрТипОбязательнаОписание
label_idstringдаID метки (начинается с lbl_) или точное имя метки. (макс. 128 символов)
rule_idstringдаID правила (начинается с lrule_) из get_label. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_label_rule",
  "arguments": {
    "label_id": "lbl_123",
    "rule_id": "lrule_123"
  }
}
Изменяет состояниеlabel_email
POST /emails/:email_id/labels

Добавить или снять метки с письма

Перемещает письмо между папками: добавляет и/или снимает метки по имени или ID вида lbl_…. Неизвестные имена в add создаются, если create не равно false.

ПараметрТипОбязательнаОписание
email_idstringдаID письма (начинается с em_), возвращённый инструментом списка или создания. (макс. 128 символов)
addstring[]нетМетки для добавления. (0–10 элементов)
removestring[]нетМетки для снятия. (0–10 элементов)
createbooleanнетСоздавать неизвестные метки из add (по умолчанию true).
ВозвращаетОбновлённое письмо с labels.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "label_email",
  "arguments": {
    "email_id": "em_123",
    "add": [
      "Billing"
    ],
    "remove": [
      "Support"
    ]
  }
}

Черновики, вложения и адреса отправителя

Только чтениеlist_sending_identities
GET /sending-identities

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

Адреса и домены, с которых это рабочее пространство может отправлять письма прямо сейчас (подтверждённые домены, их адрес From по умолчанию и активные адреса почтовых ящиков). Вызывайте перед send_email, чтобы выбрать допустимый from.

Без параметров.

Возвращает{domains: [verified domain names], addresses: [sender addresses], localParts: [...]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_sending_identities",
  "arguments": {}
}
Изменяет состояниеcreate_draft
POST /drafts

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

Создаёт черновик в редакторе. В черновиках хранятся вложения: создайте черновик, вызовите upload_attachment, затем send_email с draft_id. Ничего не отправляет.

ПараметрТипОбязательнаОписание
fromstringнетАдрес отправителя на подтверждённом домене (при создании черновика может быть пустым).
tostring[]нетПолучатели. (0–100 элементов)
ccstring[]нетПолучатели копии. (0–100 элементов)
bccstring[]нетПолучатели скрытой копии. (0–100 элементов)
subjectstringнетТема письма. (макс. 998 символов)
htmlstringнетHTML-версия письма.
textstringнетТекстовая версия письма.
reply_to_email_idstringнетID письма, на которое отвечает этот черновик.
thread_idstringнетID цепочки, к которой относится черновик.
ВозвращаетОбъект черновика {id: dr_…, from, to, cc, bcc, subject, html, text, attachments: []}.
Пример параметров tools/call
{
  "name": "create_draft",
  "arguments": {
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice"
  }
}
Только чтениеlist_drafts
GET /drafts

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

Список черновиков редактора, начиная с последних изменённых. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [drafts], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_drafts",
  "arguments": {}
}
Только чтениеget_draft
GET /drafts/:draft_id

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

Получает один черновик с метаданными вложений.

ПараметрТипОбязательнаОписание
draft_idstringдаID черновика (начинается с dr_), возвращённый инструментом списка или создания. (макс. 128 символов)
ВозвращаетОбъект черновика с attachments.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Изменяет состояниеupdate_draft
PUT /drafts/:draft_id

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

Заменяет содержимое и получателей черновика. Это полная замена: пропущенные поля очищаются, поэтому сначала прочитайте get_draft и передайте все поля, которые хотите сохранить. Вложения не затрагиваются.

ПараметрТипОбязательнаОписание
draft_idstringдаID черновика (начинается с dr_), возвращённый инструментом списка или создания. (макс. 128 символов)
fromstringнетАдрес отправителя на подтверждённом домене (при создании черновика может быть пустым).
tostring[]нетПолучатели. (0–100 элементов)
ccstring[]нетПолучатели копии. (0–100 элементов)
bccstring[]нетПолучатели скрытой копии. (0–100 элементов)
subjectstringнетТема письма. (макс. 998 символов)
htmlstringнетHTML-версия письма.
textstringнетТекстовая версия письма.
reply_to_email_idstringнетID письма, на которое отвечает этот черновик.
thread_idstringнетID цепочки, к которой относится черновик.
ВозвращаетОбновлённый объект черновика.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_draft",
  "arguments": {
    "draft_id": "dr_123",
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice (updated)",
    "text": "Attached."
  }
}
Деструктивноdelete_draft
DELETE /drafts/:draft_id

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

DESTRUCTIVE: удаляет черновик и безвозвратно удаляет его сохранённые вложения.

ПараметрТипОбязательнаОписание
draft_idstringдаID черновика (начинается с dr_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Изменяет состояниеupload_attachment
POST /drafts/:draft_id/attachments

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

Загружает один файл в черновик (не более 10 файлов и 10 МБ в сумме на письмо). Укажите content_base64 или локальный file_path. Для отправки вложений нужен платный тариф.

Укажите хотя бы одно из: content_base64, file_path.

ПараметрТипОбязательнаОписание
draft_idstringдаID черновика (начинается с dr_), возвращённый инструментом списка или создания. (макс. 128 символов)
filenamestringнетИмя файла, которое увидит получатель. По умолчанию — базовое имя из file_path. (макс. 255 символов)
content_typestringнетMIME-тип, например application/pdf. По умолчанию application/octet-stream.
content_base64stringнетСодержимое файла в стандартном base64.
file_pathstringнетАбсолютный путь к локальному файлу, доступному для чтения процессу MCP-сервера.
Возвращает{id: att_…, filename, contentType, sizeBytes, available}.
Пример параметров tools/call
{
  "name": "upload_attachment",
  "arguments": {
    "draft_id": "dr_123",
    "filename": "invoice.pdf",
    "content_type": "application/pdf",
    "file_path": "/tmp/invoice.pdf"
  }
}
Только чтениеdownload_attachment
GET /attachments/:attachment_id

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

Скачивает закрытое вложение (отправленного, полученного письма или черновика). Возвращает содержимое в base64 или записывает файл, если задан save_to_path (не перезаписывает существующий файл, если overwrite не равно true).

ПараметрТипОбязательнаОписание
attachment_idstringдаID вложения (начинается с att_), возвращённый инструментом списка или создания. (макс. 128 символов)
save_to_pathstringнетНеобязательный абсолютный локальный путь, по которому записать файл вместо возврата base64.
overwritebooleanнетРазрешить замену существующего файла по пути save_to_path. По умолчанию false.
Возвращает{attachment_id, filename, content_type, size_bytes, content_base64} or {attachment_id, filename, content_type, size_bytes, saved_to}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "download_attachment",
  "arguments": {
    "attachment_id": "att_123",
    "save_to_path": "/tmp/invoice.pdf"
  }
}
Деструктивноdelete_attachment
DELETE /attachments/:attachment_id

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

DESTRUCTIVE: безвозвратно удаляет сохранённое вложение (например, чтобы убрать файл из черновика перед отправкой).

ПараметрТипОбязательнаОписание
attachment_idstringдаID вложения (начинается с att_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_attachment",
  "arguments": {
    "attachment_id": "att_123"
  }
}

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

Только чтениеlist_templates
GET /templates

Список хранимых шаблонов

Список хранимых шаблонов писем с состоянием публикации и статистикой использования. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
lifecyclestringнетactive (по умолчанию), archived или all. (одно из active, archived, all)
querystringнетПоиск по имени или ключу. (макс. 120 символов)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [templates], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_templates",
  "arguments": {
    "lifecycle": "active"
  }
}
Изменяет состояниеcreate_template
POST /templates

Создать хранимый шаблон

Создаёт шаблон с редактируемым черновиком, при необходимости на основе заготовки (welcome, reset, receipt или blank). Перед отправкой по ключу шаблон нужно опубликовать.

ПараметрТипОбязательнаОписание
namestringдаНазвание для людей. (макс. 120 символов)
keystringнетСтабильный ключ для отправки: строчные латинские буквы, цифры, дефисы; начинается с буквы (2–64 символа). Если не указан, формируется из названия.
starterstringнетНачальное содержимое. (одно из blank, welcome, reset, receipt)
Возвращает{template, draft, activeVersion, versions, usage}.
Пример параметров tools/call
{
  "name": "create_template",
  "arguments": {
    "name": "Account welcome",
    "key": "account-welcome",
    "starter": "welcome"
  }
}
Только чтениеget_template
GET /templates/:template_id

Получить шаблон

Получает текущий черновик шаблона (с revision), активный опубликованный релиз, историю релизов и статистику использования. Принимает ID или ключ.

ПараметрТипОбязательнаОписание
template_idstringдаID шаблона (tmpl_…) или ключ. (макс. 128 символов)
Возвращает{template, draft: {id, revision, subjectTemplate, htmlTemplate, textTemplate, variables, sampleData, …} | null, activeVersion, versions, usage}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Изменяет состояниеupdate_template_draft
PUT /templates/:template_id/draft

Сохранить черновик шаблона

Сохраняет редактируемый черновик шаблона с оптимистичной блокировкой: передайте текущую revision из get_template (409 означает, что кто-то сохранил раньше; перечитайте и повторите). Это полная замена содержимого черновика: пропущенные поля очищаются, поэтому передавайте все поля, которые хотите сохранить. Используйте плейсхолдеры {{variable}}.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
revisionintegerдаТекущая ревизия черновика из get_template. (1–…)
namestringнетНазвание шаблона. (макс. 120 символов)
subject_templatestringнетТема с плейсхолдерами. (макс. 998 символов)
preheader_templatestringнетТекст предпросмотра. (макс. 240 символов)
html_templatestringнетHTML-версия письма с плейсхолдерами.
text_templatestringнетТекстовая версия письма с плейсхолдерами.
fromstringнетОтправитель по умолчанию для отправок этого шаблона.
reply_tostringнетReply-To по умолчанию.
variablesobject[]нетТипизированный контракт переменных. Каждый элемент: {key (строчные буквы/подчёркивания), label, type: text|number|url|boolean, required (по умолчанию true), fallback, description}.
variables[].keystringда
variables[].labelstringнет
variables[].typestringнет(одно из text, number, url, boolean)
variables[].requiredbooleanнет
variables[].fallbackanyнет
variables[].descriptionstringнет
sample_dataobjectнетТестовые значения для предпросмотра и тестов.
Возвращает{template, draft: {revision: next}, validation: {valid, findings}}.
Пример параметров tools/call
{
  "name": "update_template_draft",
  "arguments": {
    "template_id": "account-welcome",
    "revision": 3,
    "name": "Account welcome",
    "subject_template": "Welcome, {{first_name}}",
    "text_template": "Hi {{first_name}}",
    "variables": [
      {
        "key": "first_name",
        "type": "text",
        "required": true
      }
    ],
    "sample_data": {
      "first_name": "Asha"
    }
  }
}
Изменяет состояниеcreate_template_draft
POST /templates/:template_id/draft

Начать новый черновик на основе опубликованного релиза

Создаёт новый редактируемый черновик как копию текущего опубликованного релиза (409, если черновик уже существует или ничего не опубликовано).

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
Возвращает{draft}.
Пример параметров tools/call
{
  "name": "create_template_draft",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Только чтениеrender_template
POST /templates/:template_id/render

Отрендерить предпросмотр шаблона

Рендерит точный результат на сервере (subject, html, text) для черновика, опубликованного релиза или конкретной версии с переданными данными. Ничего не отправляет. Возвращает 422 с findings, если данные нарушают контракт переменных.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
version_idstringнетНеобязательный ID версии; по умолчанию — черновик, затем опубликованный релиз.
dataobjectнетЗначения переменных; по умолчанию — тестовые данные версии.
Возвращает{subject, html, text, preheader, versionId, versionNumber, isDraft, findings}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "render_template",
  "arguments": {
    "template_id": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}
Отправляет реальные письмаsend_template_test
POST /templates/:template_id/test

Отправить тестовое письмо по шаблону

SENDS REAL EMAIL. Send a [Test]-prefixed snapshot of the draft (or a given version) to the given recipients. Counts against usage; trial workspaces can only send to the account email or a mailbox-simulator test address.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
tostring[]даТестовые получатели. (1–100 элементов)
fromstringнетОтправитель на подтверждённом домене; по умолчанию — From шаблона.
version_idstringнетНеобязательный ID версии.
dataobjectнетЗначения переменных; по умолчанию — тестовые данные.
Возвращает{id: em_…, providerMessageId, threadId, isTest: true}.
Пример параметров tools/call
{
  "name": "send_template_test",
  "arguments": {
    "template_id": "account-welcome",
    "to": [
      "owner@example.com"
    ]
  }
}
Изменяет состояниеpublish_template
POST /templates/:template_id/publish

Опубликовать релиз шаблона

Публикует текущий черновик как неизменяемый релиз, который будет использовать send_email с template.key. Завершается ошибкой 422 с findings при ошибках валидации или 409, если публикация нарушит действующий контракт переменных шаблона, уже используемого в продакшене.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
Возвращает{template, published}.
Пример параметров tools/call
{
  "name": "publish_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Изменяет состояниеarchive_template
POST /templates/:template_id/archive

Архивировать шаблон

Останавливает новые отправки по этому шаблону (история сохраняется; можно отменить через restore_template). Любая интеграция, отправляющая по этому ключу, начнёт получать ошибку 404.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
Возвращает{template}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "archive_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Изменяет состояниеrestore_template
POST /templates/:template_id/restore

Восстановить шаблон из архива

Снова делает архивный шаблон активным.

ПараметрТипОбязательнаОписание
template_idstringдаID или ключ шаблона. (макс. 128 символов)
Возвращает{template}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "restore_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}

Домены и DNS

Только чтениеlist_domains
GET /domains

Список доменов

Список доменов отправки со сводным setup_status (verified | checking | pending), состоянием DNS по каждой записи и статусом входящей почты. Может работать медленно: неподтверждённые домены перепроверяются в реальном времени. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [domains with records], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_domains",
  "arguments": {}
}
Только чтениеget_domain
GET /domains/:domain_id

Получить параметры настройки домена

Получает один домен с точными DNS-записями для публикации (type, name, value), текущим состоянием каждой записи по данным двух публичных резолверов, dns_issues со способами исправления и статусом входящей почты.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{id, name, status, setup_status, dns_propagating, records: [{type, name, value, verified, dns_state}], dns_issues: [{code, message, …}], inbound_domain, inbound_status}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Изменяет состояниеadd_domain
POST /domains

Добавить домен отправки

Register a domain you control for sending. Returns the DNS records (Easy DKIM CNAMEs) the owner must publish. Does not change DNS itself. Counts against the plan's domain limit.

ПараметрТипОбязательнаОписание
namestringдаГолое доменное имя, например example.com или mail.example.com. (макс. 253 символа)
default_fromstringнетНеобязательный адрес отправителя по умолчанию на этом домене.
Возвращает{id: dom_…, name, status: pending, records: [...], ses: {configured}}.
Пример параметров tools/call
{
  "name": "add_domain",
  "arguments": {
    "name": "example.com"
  }
}
Изменяет состояниеverify_domain
POST /domains/:domain_id/verify

Подтвердить домен

Run a live DNS and DKIM verification check now. Safe to repeat; poll every 30–60 s after DNS changes (propagation can take minutes to hours). Sending is allowed once status is verified.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{domain, checks: {ses, dkim, dkim_status}, status: verified|pending}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "verify_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Деструктивноdelete_domain
DELETE /domains/:domain_id

Удалить домен

DESTRUCTIVE: удаляет домен из рабочего пространства вместе с маршрутом приёма входящей почты. Отправки с него сразу после этого начнут завершаться ошибкой. DNS-записи у вашего DNS-провайдера не удаляются.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Только чтениеget_dns_provider
GET /dns/provider

Определить DNS-провайдера и хосты записей

Определяет авторитетного DNS-провайдера домена и возвращает относительный хост, который нужно ввести у этого провайдера для каждой записи, рекомендуемую DMARC-запись, рекомендации по входящей MX-записи и доступность настройки в один клик (Domain Connect).

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{detectionStatus, detected, zone, nameservers, recordHosts: {recordId: host}, inbound, recommendations, authentication, providers: {domainConnect: {available, providerName}}}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_dns_provider",
  "arguments": {
    "domain_id": "dom_123"
  }
}

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

Изменяет состояниеsetup_inbound
POST /domains/:domain_id/inbound/setup

Включить приём входящей почты для домена

Provision inbound receiving for a verified domain. Uses the root domain when it has no conflicting MX, otherwise inbound.<domain>. Returns the MX record the owner must publish; it does not edit DNS.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{domain: receiving domain, status: dns_pending|ready, record: {type: MX, name, value}}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "setup_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Изменяет состояниеverify_inbound
POST /domains/:domain_id/inbound/verify

Проверить входящую MX-запись

Повторно проверяет входящую MX-запись. Статус становится ready, когда её видят оба публичных резолвера.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{domain, status: ready|dns_pending|propagating|checking, record}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "verify_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Только чтениеlist_inboxes
GET /inboxes

Список входящих адресов

Список адресов получения, при необходимости для одного домена. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
domain_idstringнетНеобязательный фильтр по ID домена.
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{id, address, name, status, domainId}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_inboxes",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Только чтениеget_inbox
GET /inboxes/:inbox_id

Получить почтовый ящик

Получает один входящий адрес.

ПараметрТипОбязательнаОписание
inbox_idstringдаID почтового ящика (начинается с inb_), возвращённый инструментом списка или создания. (макс. 128 символов)
ВозвращаетОбъект почтового ящика.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}
Изменяет состояниеcreate_inbox
POST /inboxes

Создать входящий адрес

Создаёт адрес вида support@<receiving domain> на домене со статусом входящей почты ready (сначала выполните setup_inbound и verify_inbound). Полученные письма появляются в list_emails с direction in.

ПараметрТипОбязательнаОписание
domain_idstringдаID домена (начинается с dom_), возвращённый инструментом списка или создания. (макс. 128 символов)
local_partstringдаЧасть адреса до @, например support. (макс. 64 символа)
namestringнетНеобязательное отображаемое имя.
Возвращает{id: inb_…, address, name, status: active}.
Пример параметров tools/call
{
  "name": "create_inbox",
  "arguments": {
    "domain_id": "dom_123",
    "local_part": "support",
    "name": "Support"
  }
}
Изменяет состояниеupdate_inbox
PATCH /inboxes/:inbox_id

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

Переименовывает почтовый ящик или задаёт его статус active / disabled.

ПараметрТипОбязательнаОписание
inbox_idstringдаID почтового ящика (начинается с inb_), возвращённый инструментом списка или создания. (макс. 128 символов)
namestringнетНовое отображаемое имя.
statusstringнетНовый статус. (одно из active, disabled)
ВозвращаетОбновлённый почтовый ящик.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_inbox",
  "arguments": {
    "inbox_id": "inb_123",
    "status": "disabled"
  }
}
Отправляет реальные письмаset_inbox_forwarding
PUT /inboxes/:inbox_id/forwarding

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

SENDS REAL EMAIL при пересылке кому-либо, кроме владельца аккаунта: задаёт, куда пересылаются полученные письма почтового ящика. Собственный адрес владельца активируется сразу; на любой другой адрес приходит письмо с подтверждением, и пересылка остаётся в статусе pending, пока там её не подтвердят. Передайте forward_to: null, чтобы отключить пересылку. Пересланные копии приходят с адреса ящика, исходный отправитель указывается в Reply-To.

ПараметрТипОбязательнаОписание
inbox_idstringдаID почтового ящика (начинается с inb_), возвращённый инструментом списка или создания. (макс. 128 символов)
forward_tostring,nullдаEmail-адрес, на который пересылать письма, или null, чтобы отключить пересылку. (макс. 254 символа)
ВозвращаетПочтовый ящик с forwardTo и forwardStatus (off, pending или active).
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "set_inbox_forwarding",
  "arguments": {
    "inbox_id": "inb_123",
    "forward_to": "team@example.net"
  }
}
Деструктивноdelete_inbox
DELETE /inboxes/:inbox_id

Удалить почтовый ящик

DESTRUCTIVE: удаляет входящий адрес. Уже полученные письма сохраняются; новые письма на этот адрес больше в него не попадают.

ПараметрТипОбязательнаОписание
inbox_idstringдаID почтового ящика (начинается с inb_), возвращённый инструментом списка или создания. (макс. 128 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}

Доставляемость, отказы и стоп-лист

Только чтениеdeliverability_stats
GET /deliverability/stats

Статистика доставки за 30 дней

Итоги за 30 дней по всему рабочему пространству: sent, delivery, bounce, complaint, reject, open, click и deliveryRate (%).

Без параметров.

Возвращает{window: 30d, sent, delivery, bounce, complaint, reject, open, click, deliveryRate}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "deliverability_stats",
  "arguments": {}
}
Read-onlydeliverability_account
GET /deliverability/account

Get account delivery rates

Daily ladder, today's usage, 7-day hard-bounce and complaint rates against the promote, hold, and pause thresholds, and a per-day trend. Diagnostic text is plain text.

ПараметрТипОбязательнаОписание
daysintegerнет(one of 7, 30, 90)
Returns{days, trend, rolling7d, thresholds, ladder}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "deliverability_account",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_domains
GET /deliverability/domains

Get domain delivery rates

Per sending domain: sent, delivered, hard and soft bounces, complaints, failures, rates, and an active Gmail cap or 4.7.28 backoff when one applies.

ПараметрТипОбязательнаОписание
daysintegerнет
domainstringнет
limitintegerнет
offsetintegerнет
Returns{days, data, count, limit, offset}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "deliverability_domains",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_senders
GET /deliverability/senders

Get sender delivery rates

Per From address: sent, delivered, hard and soft bounces, complaints, failures, and rates.

ПараметрТипОбязательнаОписание
daysintegerнет
domainstringнет
limitintegerнет
offsetintegerнет
Returns{days, data, count, limit, offset}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "deliverability_senders",
  "arguments": {
    "days": 30
  }
}
Read-onlyscore_email
POST /deliverability/score

Score an email's content

A checklist of one email's content before it is sent: 100 for a plain email with no links and no images, lower for each thing mail filters look at (a designed layout, links to another site than the sender's, link shorteners, images with few words, hidden text, capitals, an empty subject, very long HTML). Returns each finding with the points it costs and a one-line suggestion, most points first. Read-only: nothing is stored or sent. Pass the email as written; the unsubscribe footer and tracking SendHQ adds are not scored. It looks at content only: sender reputation, authentication and how recipients react decide more of where mail lands, so treat it as a checklist, not a prediction.

ПараметрТипОбязательнаОписание
subjectstringнетThe subject line.
htmlstringнетThe HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars)
textstringнетThe plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars)
fromstringнетThe sender: an email address or a domain such as example.com. Without it, links to other sites are not judged. (max 320 chars)
Returns{score (0 to 100), deductions: [{id, points, count, suggestion}], warnings: [{id, message}]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "score_email",
  "arguments": {
    "from": "hello@example.com",
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
  }
}
Только чтениеlist_sender_reputation
GET /deliverability/reputation

Репутация отправителей

Состояние репутации по каждому конкретному адресу From: active, throttled (сниженный дневной лимит) или paused (отправки возвращают 423) с причиной и дневным лимитом. Проверяйте, когда отправки завершаются ошибкой 423 или 429. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{sender, status, dailyLimit, reason, cleanSince, warnedAt, pausedAt, evaluatedAt}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_sender_reputation",
  "arguments": {}
}
Только чтениеlist_suppressions
GET /suppressions

Стоп-лист

Стоп-лист рабочего пространства: получатели, заблокированные после постоянного отказа или жалобы на спам. Отправки им завершаются ошибкой 422. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{email, reason, detail, created_at}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_suppressions",
  "arguments": {}
}
Деструктивноremove_suppression
DELETE /suppressions/:email

Удалить запись об отказе из стоп-листа

DESTRUCTIVE (ослабляет защитную блокировку): удаляет запись об отказе из стоп-листа, чтобы на адрес снова можно было писать. Делайте это, только когда человек подтвердил, что адрес снова действителен. Записи о жалобах удалить нельзя (409).

ПараметрТипОбязательнаОписание
emailstringдаАдрес получателя в стоп-листе. (макс. 320 символов)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "remove_suppression",
  "arguments": {
    "email": "fixed-mailbox@example.net"
  }
}
Только чтениеlist_blocked_recipients
GET /blocked-recipients

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

Все получатели, которым SendHQ откажет в отправке: отказы, жалобы и отписки от маркетинговых писем в рамках домена, со сводкой по типам. Читает до 500 самых свежих записей. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{email, domain, kind: bounce|complaint|unsubscribe, reason, detail, source, status, created_at}], count, summary: {total, bounce, complaint, unsubscribe}, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_blocked_recipients",
  "arguments": {}
}

Campaigns

Read-onlylist_contacts
GET /contacts

List contacts

Campaigns: Newest-first contacts with their status, consent evidence, tags, custom fields, engagement (bot-filtered, estimated opens and clicks), and the lists they are subscribed to. Filter by list, status (including dormant), email/name substring (* is an email wildcard, e.g. *@example.com), tag, source, signup date, or a saved segment. Paginated: the result includes pagination {offset, limit, returned, has_more, next_offset}.

ПараметрТипОбязательнаОписание
list_idstringнетOnly members of this list (lst_…).
statusstringнетOnly contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant)
querystringнетEmail or name contains this text; * is a wildcard on the email. (max 200 chars)
tagstringнетOnly contacts with this tag. (max 60 chars)
sourcestringнетHow the contact was added. (one of form, api, import)
afterstringнетSigned up at or after this time. ISO 8601 date or date-time. (max 40 chars)
beforestringнетSigned up before this time. ISO 8601 date or date-time. (max 40 chars)
segment_idstringнетOnly contacts matching this saved segment (seg_…).
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [contacts with tags, engagement, dormant, country], count, total, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_contacts",
  "arguments": {
    "status": "subscribed"
  }
}
Changes statecreate_contact
POST /contacts

Add a contact

Campaigns: Add one contact to the workspace, optionally to lists and with tags. A subscribed contact (the default) needs consent_basis: how this person agreed to receive your email. Only add people who asked for your email. Use status: unsubscribed to record an opt-out. Addresses already suppressed or unsubscribed from the workspace are stored with that status. Fails with 409 if the email already exists.

ПараметрТипОбязательнаОписание
emailstringдаEmail address. (max 320 chars)
namestringнетDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectнетCustom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field.
tagsstring[]нетTags to attach, e.g. ["VIP"]. Up to 50. (0–50 items)
list_idsstring[]нетLists to add the contact to (lst_…). (0–100 items)
statusstringнетsubscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed)
consent_basisstringнетHow these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars)
ReturnsThe contact.
Пример параметров tools/call
{
  "name": "create_contact",
  "arguments": {
    "email": "ada@example.net",
    "name": "Ada Lovelace",
    "consent_basis": "Ticked the newsletter box at checkout on acme.com"
  }
}
Changes stateupsert_contact
PUT /contacts

Create or update a contact by email

Campaigns: Create the contact with this email, or change the one that exists: set name, timezone, and locale, merge fields, and add tags. A new contact needs consent_basis and takes the status its address already has (bounced or complained when suppressed, unsubscribed when it opted out, otherwise subscribed). An existing contact's status is never changed, so nobody is resubscribed. Unlike create_contact it does not fail when the email exists. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
emailstringдаEmail address. (max 320 chars)
namestringнетDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectнетCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
tagsstring[]нетTags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items)
timezonestringнетIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
localestringнетLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
consent_basisstringнетHow this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars)
ReturnsThe contact, plus timezone, locale, and created (true when it did not exist before).
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "upsert_contact",
  "arguments": {
    "email": "ada@example.net",
    "name": "Ada Lovelace",
    "fields": {
      "plan": "pro"
    },
    "timezone": "Europe/London",
    "consent_basis": "Created an account on acme.com and accepted product emails"
  }
}
Read-onlyget_contact
GET /contacts/:contact_id

Get a contact

Campaigns: One contact by ID or email: status, consent evidence (source, basis, opt-in and confirmation times), custom fields, and subscribed lists.

ПараметрТипОбязательнаОписание
contact_idstringдаContact ID (starts with ct_) or the contact's email address. (max 320 chars)
ReturnsThe contact.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateupdate_contact
PATCH /contacts/:contact_id

Update, tag, or unsubscribe a contact

Campaigns: Change a contact's name, merge custom fields (null removes one), change tags (tags replaces the whole set; add_tags and remove_tags change it), or set status to unsubscribed. A contact can never be resubscribed through the API; only the recipient can, by confirming a signup form.

ПараметрТипОбязательнаОписание
contact_idstringдаContact ID (starts with ct_) or the contact's email address. (max 320 chars)
namestringнетNew display name. (max 200 chars)
fieldsobjectнетCustom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field.
tagsstring[]нетReplace all of the contact's tags with these. (0–50 items)
add_tagsstring[]нетTags to add. (0–50 items)
remove_tagsstring[]нетTags to remove. (0–50 items)
statusstringнетOnly unsubscribed is accepted. (one of unsubscribed)
ReturnsThe updated contact.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_contact",
  "arguments": {
    "contact_id": "ct_123",
    "fields": {
      "plan": "team"
    }
  }
}
Destructivedelete_contact
DELETE /contacts/:contact_id

Delete a contact

DESTRUCTIVE: permanently delete a contact and its list memberships. Suppressions and recorded unsubscribes are kept, so the address still cannot be mailed if it is added again. Part of Campaigns.

ПараметрТипОбязательнаОписание
contact_idstringдаContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateimport_contacts
POST /contact-imports

Import contacts from CSV

Campaigns: Import up to 5,000 CSV rows (5 MB) per call, optionally into a list. The header row needs an email column; name (or first_name/last_name), status, and tags (separated by ; or |) are recognized and other columns become custom fields. consent_basis is required and recorded on every new contact. tags are added to every accepted row. Rows whose status says unsubscribed import as unsubscribed; existing contacts keep their status. Returns counts of accepted, created, existing, skipped (duplicates), and invalid rows with line numbers.

ПараметрТипОбязательнаОписание
csvstringдаThe CSV file content, header row first. (max 5242880 chars)
list_idstringнетAdd every accepted row to this list (lst_…).
consent_basisstringдаHow these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars)
tagsstring[]нетTags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items)
update_existingbooleanнетMerge names and fields into contacts that already exist. Their status never changes.
Returns{id, accepted, created, existing, skipped, invalid, errors: [{line, reason}], tags}.
Пример параметров tools/call
{
  "name": "import_contacts",
  "arguments": {
    "csv": "email,name\nada@example.net,Ada Lovelace\n",
    "consent_basis": "Newsletter signups exported from Mailchimp (double opt-in)"
  }
}
Read-onlylist_contact_imports
GET /contact-imports

List contact imports

Campaigns: Recent CSV imports with their consent basis and row counts.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [imports], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_contact_imports",
  "arguments": {}
}
Destructivebulk_update_contacts
POST /contacts/bulk

Bulk update contacts

DESTRUCTIVE when action is delete (permanent) or unsubscribe (cannot be undone through the API). Apply one action to up to 10,000 contacts: the IDs in contact_ids, or everyone matching filter (the list_contacts filters). Actions: tag / untag (with tags), add_to_list / remove_from_list (with list_id), unsubscribe, delete. Adding to a list mirrors each contact's status, so nobody is resubscribed. delete needs confirm_count equal to the number of contacts it would delete: call once without it to get that count (409), confirm with the user, then repeat with it. Part of Campaigns.

ПараметрТипОбязательнаОписание
actionstringдаWhat to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete)
contact_idsstring[]нетContact IDs (ct_…). Use this or filter. (0–10000 items)
filterobjectнетEveryone matching these list_contacts filters. Use this or contact_ids.
filter.list_idstringнетMembers of this list.
filter.statusstringнетOnly contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant)
filter.querystringнетEmail or name contains; * is an email wildcard. (max 200 chars)
filter.tagstringнетHas this tag. (max 60 chars)
filter.sourcestringнетHow the contact was added. (one of form, api, import)
filter.afterstringнетSigned up at or after. ISO 8601 date or date-time. (max 40 chars)
filter.beforestringнетSigned up before. ISO 8601 date or date-time. (max 40 chars)
filter.segment_idstringнетMatches this segment.
tagsstring[]нетFor tag and untag. (0–50 items)
list_idstringнетFor add_to_list and remove_from_list (lst_…).
confirm_countintegerнетFor delete: the number of contacts that will be deleted, from the 409 response. (0–…)
Returns{ok, action, count}; for an unconfirmed delete, a 409 error whose message gives the count.
AnnotationsdestructiveHint
Пример параметров tools/call
{
  "name": "bulk_update_contacts",
  "arguments": {
    "action": "tag",
    "tags": [
      "october"
    ],
    "filter": {
      "list_id": "lst_123",
      "status": "subscribed"
    }
  }
}
Read-onlylist_tags
GET /tags

List contact tags

Campaigns: The workspace's contact tags, most used first, with how many contacts carry each (up to 500). Paginated.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{tag, count}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_tags",
  "arguments": {}
}
Read-onlylist_contact_fields
GET /contact-fields

List custom contact fields

Campaigns: Defined custom contact fields with label and type (text, number, date). Defined fields are known to check_broadcast's merge-tag check and typed in segment conditions. Contacts may also carry undefined keys. Paginated.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{key, label, type, createdAt}], count, types, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_contact_fields",
  "arguments": {}
}
Changes stateset_contact_field
PUT /contact-fields/:field_key

Define a custom contact field

Campaigns: Create or change a custom field definition (label and type). Values live on each contact's fields. Built-in merge tags (email, name, first_name, last_name, fields, unsubscribe_url) cannot be used as keys. A workspace may define 50 fields.

ПараметрТипОбязательнаОписание
field_keystringдаField key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars)
labelstringнетLabel shown in the dashboard. Defaults to the key. (max 80 chars)
typestringнетtext (default), number, or date. (one of text, number, date)
Returns{key, label, type, createdAt}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "set_contact_field",
  "arguments": {
    "field_key": "plan",
    "label": "Plan",
    "type": "text"
  }
}
Destructivedelete_contact_field
DELETE /contact-fields/:field_key

Delete a custom field definition

DESTRUCTIVE: delete a custom field definition. Values already stored on contacts are kept. Fails with 404 when the field is not defined. Part of Campaigns.

ПараметрТипОбязательнаОписание
field_keystringдаField key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_contact_field",
  "arguments": {
    "field_key": "plan"
  }
}
Read-onlylist_segments
GET /segments

List segments

Campaigns: Saved segments with count (subscribed, non-dormant contacts in the workspace that match now) and fields, the condition fields and operators each accepts. Paginated.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{id, name, match, conditions, count}], count, fields, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_segments",
  "arguments": {}
}
Read-onlyget_segment
GET /segments/:segment_id

Get a segment

Campaigns: One segment with its conditions and live count.

ПараметрТипОбязательнаОписание
segment_idstringдаSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Returns{id, name, match, conditions, count}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlypreview_segment
POST /segments/preview

Preview segment conditions

Campaigns: Count and sample (up to 5) the subscribed, non-dormant contacts that match conditions without saving them. Read-only; use it to check conditions before create_segment.

ПараметрТипОбязательнаОписание
matchstringнетall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]нетUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringдаtag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars)
conditions[].keystringнетCustom field key when field is field. (max 40 chars)
conditions[].opstringдаtag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numberнетRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
Returns{count, sample: [contacts]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "preview_segment",
  "arguments": {
    "match": "all",
    "conditions": [
      {
        "field": "tag",
        "op": "has",
        "value": "VIP"
      },
      {
        "field": "opened",
        "op": "in_last_days",
        "value": 90
      }
    ]
  }
}
Changes statecreate_segment
POST /segments

Create a segment

Campaigns: Save a segment: up to 20 conditions joined by match. Use it as a broadcast's audience.segment_id, as list_contacts segment_id, or in bulk_update_contacts filters. A workspace may have 200 segments.

ПараметрТипОбязательнаОписание
namestringдаSegment name. (max 120 chars)
matchstringнетall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]нетUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringдаtag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars)
conditions[].keystringнетCustom field key when field is field. (max 40 chars)
conditions[].opstringдаtag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numberнетRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
ReturnsThe segment with its count.
Пример параметров tools/call
{
  "name": "create_segment",
  "arguments": {
    "name": "Engaged pro customers",
    "conditions": [
      {
        "field": "fields.plan",
        "op": "equals",
        "value": "pro"
      },
      {
        "field": "opened",
        "op": "in_last_days",
        "value": 90
      }
    ]
  }
}
Changes stateupdate_segment
PATCH /segments/:segment_id

Update a segment

Campaigns: Rename a segment or change match or conditions (which replaces the whole list). Broadcasts using it pick up the change when they start sending.

ПараметрТипОбязательнаОписание
segment_idstringдаSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
namestringнетSegment name. (max 120 chars)
matchstringнетall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]нетUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringдаtag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars)
conditions[].keystringнетCustom field key when field is field. (max 40 chars)
conditions[].opstringдаtag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numberнетRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
ReturnsThe updated segment with its count.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_segment",
  "arguments": {
    "segment_id": "seg_123",
    "name": "Pro customers"
  }
}
Destructivedelete_segment
DELETE /segments/:segment_id

Delete a segment

DESTRUCTIVE: delete a saved segment. Contacts are not affected. Fails with 409 while a sending or scheduled broadcast uses it. Part of Campaigns.

ПараметрТипОбязательнаОписание
segment_idstringдаSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlylist_lists
GET /lists

List contact lists

Campaigns: Contact lists with subscribed, pending, and unsubscribed counts and their hosted signup form settings.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [lists], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_lists",
  "arguments": {}
}
Changes statecreate_list
POST /lists

Create a list

Campaigns: Create a contact list. Set form_enabled to publish a hosted double opt-in signup form (its URL is in form.url); form_from is the sender, on a verified domain, of the confirmation email, and redirect_url is an optional https page shown after confirming. welcome sends one welcome email when someone confirms. site publishes a public newsletter site at https://sendhq.cc/n/<slug> with the signup form, sent issues, and RSS.

ПараметрТипОбязательнаОписание
namestringдаList name, shown on the signup form. (max 200 chars)
descriptionstringнетShort description shown on the signup form. (max 500 chars)
form_enabledbooleanнетPublish the hosted signup form.
form_fromstringнетSender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars)
redirect_urlstringнетhttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectнетWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleanнетSend it.
welcome.subjectstringнетSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringнетHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringнетMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectнетPublic newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409.
site.enabledbooleanнетPublish the site.
site.slugstring,nullнетAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullнетSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullнетShort description under the title. (max 300 chars)
site.accentstring,nullнетAccent color, e.g. #0a7d4f.
ReturnsThe list.
Пример параметров tools/call
{
  "name": "create_list",
  "arguments": {
    "name": "Product updates"
  }
}
Read-onlyget_list
GET /lists/:list_id

Get a list

Campaigns: One list with member counts and signup form settings.

ПараметрТипОбязательнаОписание
list_idstringдаList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
ReturnsThe list.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateupdate_list
PATCH /lists/:list_id

Update a list

Campaigns: Rename a list, change its description, or change its hosted signup form, welcome email, or newsletter site. Omitted keys inside welcome and site keep their value.

ПараметрТипОбязательнаОписание
list_idstringдаList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
namestringнетNew name. (max 200 chars)
descriptionstringнетNew description. (max 500 chars)
form_enabledbooleanнетPublish or unpublish the hosted signup form.
form_fromstringнетSender of signup confirmation emails, on a verified domain. (max 320 chars)
redirect_urlstringнетhttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectнетWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleanнетSend it.
welcome.subjectstringнетSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringнетHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringнетMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectнетPublic newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409.
site.enabledbooleanнетPublish the site.
site.slugstring,nullнетAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullнетSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullнетShort description under the title. (max 300 chars)
site.accentstring,nullнетAccent color, e.g. #0a7d4f.
ReturnsThe updated list.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_list",
  "arguments": {
    "list_id": "lst_123",
    "form_enabled": false
  }
}
Destructivedelete_list
DELETE /lists/:list_id

Delete a list

DESTRUCTIVE: delete a list and its memberships. The contacts themselves are kept. Fails with 409 while a broadcast to the list is sending. Part of Campaigns.

ПараметрТипОбязательнаОписание
list_idstringдаList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateadd_list_contacts
POST /lists/:list_id/contacts

Add contacts to a list

Campaigns: Add up to 500 existing contacts to a list by ID or email. Subscribed contacts join subscribed; others join in their current state. Unknown references come back in notFound.

ПараметрТипОбязательнаОписание
list_idstringдаList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idsstring[]нетContact IDs (ct_…). (0–500 items)
emailsstring[]нетContact email addresses. (0–500 items)
Returns{listId, added, notFound, list}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "add_list_contacts",
  "arguments": {
    "list_id": "lst_123",
    "emails": [
      "ada@example.net"
    ]
  }
}
Destructiveremove_list_contact
DELETE /lists/:list_id/contacts/:contact_id

Remove a contact from a list

DESTRUCTIVE: remove one contact from a list. The contact and its status are kept. Part of Campaigns.

ПараметрТипОбязательнаОписание
list_idstringдаList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idstringдаContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "remove_list_contact",
  "arguments": {
    "list_id": "lst_123",
    "contact_id": "ct_123"
  }
}
Read-onlylist_broadcasts
GET /broadcasts

List broadcasts

Campaigns: Newest-first broadcasts with their status. Paginated: the result includes pagination.

ПараметрТипОбязательнаОписание
statusstringнетOnly broadcasts with this status. (one of draft, sending, sent, cancelled, failed)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [broadcasts], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_broadcasts",
  "arguments": {}
}
Changes statecreate_broadcast
POST /broadcasts

Create a broadcast draft

Campaigns: Create a draft broadcast to one list. Content is html and/or text, markdown, a block document in content, or a published hosted template. Raw content supports merge tags: {{first_name}}, {{name}}, {{email}}, {{fields.plan}}, with fallbacks like {{first_name | there}}. audience narrows it to a segment and/or a number of people (most engaged first with order: engaged); tracking turns open and click tracking off; web publishes it on the list's newsletter site once sent. Nothing is sent until send_broadcast or schedule_broadcast; run check_broadcast and send_broadcast_test first.

ПараметрТипОбязательнаОписание
namestringнетInternal name. Defaults to the subject. (max 200 chars)
list_idstringнетThe list to send to (lst_…).
fromstringнетSender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars)
reply_tostringнетReply-To address. (max 320 chars)
subjectstringнетSubject line; merge tags allowed. (max 998 chars)
preview_textstringнетInbox preview text shown after the subject. (max 300 chars)
htmlstringнетHTML body; merge tags allowed and escaped.
textstringнетPlain-text body; merge tags allowed.
templateobjectнетA published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields.
template.idstringнет
template.keystringнет
template.version_idstringнет
markdownstringнетMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullнетBlock document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent.
editorstringнетWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectнетWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullнетOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringнетWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullнетSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectнетOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleanнетAdd an open pixel.
tracking.clicksbooleanнетRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectнетPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleanнетPublish it.
web.slugstring,nullнетIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleanнетKeep it at the top of the site.
ReturnsThe draft broadcast.
Пример параметров tools/call
{
  "name": "create_broadcast",
  "arguments": {
    "list_id": "lst_123",
    "from": "news@example.com",
    "subject": "October update",
    "markdown": "Hi {{first_name | there}}, here's what shipped.",
    "audience": {
      "order": "engaged",
      "limit": 1000
    }
  }
}
Read-onlyget_broadcast
GET /broadcasts/:broadcast_id

Get a broadcast

Campaigns: One broadcast with its content and, once sending, recipient totals (queued, sending, sent, held, skipped, failed). While a limit or reputation pause holds delivery, lastError explains why and nextAttemptAt says when it resumes.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe broadcast.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateupdate_broadcast
PATCH /broadcasts/:broadcast_id

Edit a draft broadcast

Campaigns: Change any field of an unscheduled draft broadcast (content, audience, tracking, web). A scheduled draft must be unscheduled first (unschedule_broadcast); sent or sending broadcasts cannot be edited.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
namestringнетInternal name. (max 200 chars)
list_idstringнетThe list to send to.
fromstringнетSender on a verified domain. (max 320 chars)
reply_tostringнетReply-To address. (max 320 chars)
subjectstringнетТема письма. (макс. 998 символов)
preview_textstringнетInbox preview text. (max 300 chars)
htmlstringнетHTML-версия письма.
textstringнетТекстовая версия письма.
templateobject,nullнетA published hosted template, or null to remove it.
markdownstringнетMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullнетBlock document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent.
editorstringнетWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectнетWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullнетOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringнетWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullнетSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectнетOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleanнетAdd an open pixel.
tracking.clicksbooleanнетRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectнетPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleanнетPublish it.
web.slugstring,nullнетIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleanнетKeep it at the top of the site.
ReturnsThe updated draft.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "subject": "October product update"
  }
}
Destructivedelete_broadcast
DELETE /broadcasts/:broadcast_id

Delete a draft broadcast

DESTRUCTIVE: permanently delete a draft broadcast. Broadcasts that were sent cannot be deleted. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast
POST /broadcasts/:broadcast_id/send

Send a broadcast

SENDS REAL EMAIL to the broadcast's audience: every subscribed, non-dormant member of its list, narrowed by its segment and limit. Only call it when the user asked to send this broadcast now. Each message goes through the normal checks (verified domain, marketing plan, suppressions, unsubscribes, reputation, daily and monthly limits) and carries one-click unsubscribe from this list; members that cannot be mailed are skipped. Each contact is sent at most once. Delivery continues in the background: poll get_broadcast for totals and get_broadcast_report for engagement. A scheduled broadcast fails with 409 until unscheduled. Unpaid workspaces (integration trial) can send only to the account email. Pass idempotency_key so a retry cannot start the send twice. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
idempotency_keystringнетЗаголовок Idempotency-Key (макс. 200 символов). Используйте его повторно, только чтобы повторить этот же запрос. (макс. 200 символов)
ReturnsThe broadcast with status sending and totals.
Пример параметров tools/call
{
  "name": "send_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "idempotency_key": "october-update"
  }
}
Destructivecancel_broadcast
POST /broadcasts/:broadcast_id/cancel

Cancel a broadcast

DESTRUCTIVE: stop a draft or sending broadcast for good. Recipients not yet sent are marked skipped; messages already handed to the provider are not recalled. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe cancelled broadcast with totals.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "cancel_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlylist_broadcast_recipients
GET /broadcasts/:broadcast_id/recipients

List broadcast recipients

Campaigns: Per-recipient outcomes and engagement of a broadcast: queued, sending, sent, held, skipped (with the reason), or failed (with the error), the inbox provider, delivered/opened/clicked/bounced/complained/unsubscribed times, and the email ID to inspect delivery events with list_email_events. Filter by outcome, by activity (who opened, clicked, did not open, ...), or by email. Opens are bot-filtered estimates, never proof of reading. Paginated.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
statusstringнетOnly recipients with this outcome. (one of queued, sending, sent, held, skipped, failed)
activitystringнетOnly recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed)
querystringнетRecipient email contains this text. (max 200 chars)
includestringнетlinks adds the links each recipient clicked (implied by activity: clicked). (one of links)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{contactId, email, status, skipReason, emailId, error, provider, deliveredAt, openedAt, clickedAt, opens, clicks, bouncedAt, complainedAt, unsubscribedAt, links?}], count, totals, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_broadcast_recipients",
  "arguments": {
    "broadcast_id": "bc_123",
    "status": "failed"
  }
}
Read-onlycheck_broadcast
GET /broadcasts/:broadcast_id/checks

Run a broadcast's pre-send checks

Campaigns: The review list shown before sending: sender verification, subject, preview text, content, audience size, size against Gmail's 102 KB clipping limit, postal address, merge tags without data or fallback, empty or shortened links, image descriptions, placeholder text, spam-prone wording, the trial's own-address rule, and whether a test was sent. ready is false while any check has level block; schedule_broadcast refuses then. Fix warn items or tell the user about them.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{ready, checks: [{id, level: ok|warn|block, label, detail}], audience: {total, matching}}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "check_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_test
POST /broadcasts/:broadcast_id/test

Send a broadcast test

SENDS REAL EMAIL: a copy of the draft marked [Test] to up to 5 addresses (default: the saved test recipients, or the account email), with merge tags filled from contact_id or a sample contact. Never goes to the list. Only send to addresses the user gave or owns. Limited to 100 test sends a day. Template broadcasts are tested with send_template_test. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
tostring[]нетTest recipients (up to 5). (1–5 items)
contact_idstringнетFill merge tags from this contact (ct_…). (max 320 chars)
rememberbooleanнетSave to as the default test recipients.
Returns{data: [{to, id, status: sent|failed, error?}]}.
Пример параметров tools/call
{
  "name": "send_broadcast_test",
  "arguments": {
    "broadcast_id": "bc_123",
    "to": [
      "owner@example.com"
    ]
  }
}
Sends real emailschedule_broadcast
POST /broadcasts/:broadcast_id/schedule

Schedule a broadcast

SENDS REAL EMAIL at scheduled_at to the broadcast's audience, with the same checks as send_broadcast. Only call it when the user asked to send this broadcast at that time. The pre-send checks run now (422 with checks if one blocks). It starts within about a minute of the time; if it can no longer send then, it returns to a draft with the reason in lastError. A scheduled draft cannot be edited until unschedule_broadcast. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
scheduled_atstringдаWhen to send: ISO 8601 date-time with a timezone, at least a minute and at most a year ahead, e.g. 2026-11-10T09:00:00Z. (max 40 chars)
ReturnsThe broadcast with scheduledAt.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "schedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "scheduled_at": "2026-11-10T09:00:00Z"
  }
}
Changes stateunschedule_broadcast
POST /broadcasts/:broadcast_id/unschedule

Unschedule a broadcast

Campaigns: Return a scheduled broadcast to an editable draft so it does not send. Fails with 409 when it is not scheduled.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe draft broadcast.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "unschedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateduplicate_broadcast
POST /broadcasts/:broadcast_id/duplicate

Duplicate a broadcast

Campaigns: Copy any broadcast (draft, sent, or cancelled) into a new draft named <name> (copy) with the same list, sender, content, audience, and tracking settings. Nothing is sent.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe new draft broadcast.
Пример параметров tools/call
{
  "name": "duplicate_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_to_more
POST /broadcasts/:broadcast_id/send-more

Send a broadcast to more people

SENDS REAL EMAIL: sends a sent or sending broadcast to up to limit more people in its audience who have not received it (the rest of a limited audience, or people who joined since), in its audience order. Only call it when the user asked for this. Same checks as send_broadcast; each contact still gets it at most once. Fails with 422 when everyone already got it. Pass idempotency_key so a retry cannot add people twice. Part of Campaigns.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
limitintegerдаHow many more people at most. (1–10000000)
idempotency_keystringнетЗаголовок Idempotency-Key (макс. 200 символов). Используйте его повторно, только чтобы повторить этот же запрос. (макс. 200 символов)
Returns{added, broadcast}.
Пример параметров tools/call
{
  "name": "send_broadcast_to_more",
  "arguments": {
    "broadcast_id": "bc_123",
    "limit": 500,
    "idempotency_key": "october-update-more-1"
  }
}
Read-onlyget_broadcast_report
GET /broadcasts/:broadcast_id/report

Get a broadcast report

Campaigns: Engagement for a sending or sent broadcast: unique and total opens and clicks, bounces, complaints, and unsubscribes with rates in percent, the same per inbox provider, clicks per link, first opens and clicks by hour, and the average of the previous five broadcasts. Opens are estimates: automated requests (scanners, link previews, privacy prefetching) are counted only in machine. Never claim that a person read the email. Fails with 409 for a draft.

ПараметрТипОбязательнаОписание
broadcast_idstringдаBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{stats: {sent, delivered, opened, clicked, bounced, complained, unsubscribed, opens, clicks, rates}, providers, links, timeline, average, machine, tracking, totals, remaining}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_broadcast_report",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlyget_newsletter_settings
GET /newsletter-settings

Get newsletter settings

Campaigns: The postal address added to every marketing email footer, the design (accent color, font, alignment) used for Markdown and block content, list cleanup settings, and default test recipients.

Без параметров.

Returns{postalAddress, design: {accentColor, font, align}, cleanup: {enabled, afterSends, quietDays, subject, body, from}, testRecipients}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_newsletter_settings",
  "arguments": {}
}
Changes stateupdate_newsletter_settings
PATCH /newsletter-settings

Update newsletter settings

Campaigns: Change the postal address (required in marketing email by CAN-SPAM and CASL), design, list cleanup, or default test recipients. Omitted keys keep their value. List cleanup is on by default and sends email automatically: a subscriber who got afterSends broadcasts in a row without opening or clicking and has been quiet for quietDays gets one "still want these?" email; a week later those who did not confirm become dormant (kept, but skipped by broadcasts). Confirm with the user before turning it on or changing its email.

ПараметрТипОбязательнаОписание
postal_addressstringнетSender's postal address for the footer. Empty string removes it. (max 300 chars)
designobjectнетRendering design for Markdown and block content.
design.accentColorstring,nullнетHex color like #0a7d4f, or null for the default.
design.fontstringнетFont family. (one of sans, serif, mono)
design.alignstringнетText alignment. (one of left, center)
cleanupobjectнетList cleanup of readers who stopped opening.
cleanup.enabledbooleanнетTurn list cleanup on or off.
cleanup.afterSendsintegerнетBroadcasts in a row without an open or click (3-50). (3–50)
cleanup.quietDaysintegerнетDays without engagement (30-730). (30–730)
cleanup.subjectstring,nullнетSubject of the cleanup email; merge tags allowed. (max 200 chars)
cleanup.bodystring,nullнетBody text of the cleanup email. (max 2000 chars)
cleanup.fromstring,nullнетSender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars)
test_recipientsstring[]нетDefault addresses for send_broadcast_test (up to 5). (0–5 items)
ReturnsThe updated settings.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_newsletter_settings",
  "arguments": {
    "postal_address": "Acme Inc., 1 Main St, Springfield",
    "design": {
      "accentColor": "#0a7d4f"
    }
  }
}
Read-onlyget_campaign_overview
GET /campaigns/overview

Get campaign overview

Campaigns: Subscriber growth and recent results for the last days (7-365, default 30): active, dormant, and pending subscribers, joined and left, a daily series, and the six latest broadcasts with open and click rates (bot-filtered estimates) and their average.

ПараметрТипОбязательнаОписание
daysintegerнетWindow in days, 7 to 365. Defaults to 30. (7–365)
Returns{subscribers: {active, dormant, pending, joined, left}, series: [{day, subscribers, joined, left}], recent: [{id, name, subject, status, startedAt, sent, openRate, clickRate}], averages}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_campaign_overview",
  "arguments": {
    "days": 30
  }
}
Read-onlylist_uploaded_images
GET /uploads/images

List uploaded images

Campaigns: The workspace's 60 most recent editor image uploads with their public URLs (https://sendhq.cc/i/<id>), to reuse in broadcast HTML, Markdown, or image blocks. Uploading needs the dashboard or the REST API (raw image body). Paginated.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{id, url, width, height, size, filename, createdAt}], pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_uploaded_images",
  "arguments": {}
}

Automations, events, and sending limits

Sends real emailtrack_event
POST /events

Record something a contact did

SENDS REAL EMAIL later, when an automation is listening: the contact enters every automation that is on and starts on this event, and that automation then emails them on its schedule, within the workspace's sending limits and hours. Only record what the person really did. In order: the contact changes in contact and the event are saved; open enrolments whose automation names the event as its goal end as converted, and ones that list it as a stop event end; then the contact enters the automations that start on it, unless already in them or reentry forbids it. A contact that is unsubscribed, bounced, or complained is recorded and can leave automations but never enters one. A new contact needs contact.consent_basis. Pass dedupe_key so a retry changes nothing and returns the first result. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
emailstringдаThe contact's email address. (max 320 chars)
eventstringдаWhat they did: a lowercase letter, then a-z, 0-9, and _ (e.g. checkout_started). Names starting email. are reserved. (max 64 chars)
propertiesobjectнетUp to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved.
occurred_atstringнетWhen it happened, ISO 8601 with a time zone. Defaults to now; may not be in the future. The automation's emails are timed from it. (max 40 chars)
dedupe_keystringнетStable ID for this event (max 200 chars). A second call with the same key records nothing and returns the first result. (max 200 chars)
contactobjectнетChanges to the contact, applied with the event.
contact.namestringнетDisplay name. (max 200 chars)
contact.fieldsobjectнетCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
contact.timezonestringнетIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
contact.localestringнетLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
contact.consent_basisstringнетHow this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars)
Returns{id, contact_id, started: [automation keys the contact entered], ended: [automation keys the contact left]}.
Пример параметров tools/call
{
  "name": "track_event",
  "arguments": {
    "email": "ada@example.net",
    "event": "checkout_started",
    "properties": {
      "plan": "pro"
    },
    "dedupe_key": "checkout_8f3a"
  }
}
Read-onlylist_automations
GET /automations

List automations

Automations: Every automation in priority order with its status (draft, on, or off), how many emails it has, and totals for the last 30 days (entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held). held counts each time an email was made to wait by the sending limits, the sending hours, or the automation's daily cap. Each automation carries domain, the domain of its from_address (null while it has no sender). domain narrows the list to the automations that send from one domain (none: those with no sender yet); domains always lists every sender domain of the workspace, in alphabetical order, with how many automations each has. Email bodies are not included; use get_automation. For other date ranges and daily numbers use get_automation_report. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
domainstringнетOnly the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at} plus steps_count and totals], count, domains: [{domain, count}], pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_automations",
  "arguments": {
    "domain": "example.com"
  }
}
Read-onlyget_automation
GET /automations/:automation_key

Get an automation

Automations: One automation with its emails in order and their language versions, how many people are in it now, and overlap: the other automations that are on and currently have the same people in them, with goes_first true for one that ranks above this automation (the shared people get its emails first and wait in this one). to_fill lists what must still be filled in before it can be turned on: placeholders of the template library left in its emails, and workspace names they print that are blank. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
ReturnsThe automation (with domain, the domain of its from_address, or null) with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, overlap [{key, name, contacts, position, goes_first}], merge_fields [{key, label}]: the merge tags its emails print, in plain words, and to_fill [{id, position, locale, where, placeholder, key, message}].
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Changes statecreate_automation
POST /automations

Create an automation

Automations: Create a timed sequence of emails for one kind of person, as a draft. To start from a ready-made email instead (welcome, onboarding, trial, abandoned checkout, failed payment, winback and more), use use_automation_template. Nothing is sent until set_automation_status turns it on. key is its address and cannot be changed. entry says how people enter, exit_rules when they leave, and steps are the emails, each due offset_seconds after the person entered. from_address must be on a verified domain. Fails with 409 when the key is taken. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
keystringдаAddress of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars)
namestringдаName shown in the dashboard. (max 200 chars)
audience_labelstringнетWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringнетWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectнетHow people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end.
entry.typestringдаEntry type. (one of event, bucket, date_field, manual)
entry.eventstringнетEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringнетSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringнетContact field key for a date_field entry. (max 40 chars)
entry.reentrystringнетWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectнетWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullнетEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleanнетTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]нетEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegerнетDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectнетPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleanнетSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullнетAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullнетStored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…)
settings.holdout_pctnumberнетPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegerнетAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegerнетHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegerнетPriority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000)
from_namestringнетSender display name, e.g. Acme. (max 120 chars)
from_addressstringнетSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringнетReply-To address. (max 320 chars)
stepsobject[]нетThe emails, in order. position defaults to the place in this list. (0–50 items)
steps[].positionintegerнетPosition of the email in the automation, 1 to 50. (1–50)
steps[].subjectstringнетSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
steps[].preheaderstringнетInbox preview line. (max 300 chars)
steps[].contentobjectнетBlock document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html.
steps[].htmlstringнетHTML body. The unsubscribe footer is added automatically.
steps[].textstringнетТекстовая версия письма.
steps[].editorstringнетHow the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design)
steps[].offset_secondsintegerнетWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
steps[].skip_if_emptystring[]нетMerge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items)
steps[].ignore_send_windowbooleanнетSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
Пример параметров tools/call
{
  "name": "create_automation",
  "arguments": {
    "key": "checkout-recovery",
    "name": "Checkout recovery",
    "audience_label": "Started checkout and left",
    "goal_label": "paid",
    "from_name": "Acme",
    "from_address": "hello@example.com",
    "entry": {
      "type": "event",
      "event": "checkout_started"
    },
    "exit_rules": {
      "goal_event": "payment_completed"
    },
    "steps": [
      {
        "offset_seconds": 3600,
        "subject": "Still thinking it over, {{ first_name | there }}?",
        "html": "<p>Your cart is waiting.</p>"
      }
    ]
  }
}
Changes stateupdate_automation
PATCH /automations/:automation_key

Edit an automation

Automations: Change an automation's name, labels, entry, exit rules, sender, or priority. settings are merged; entry and exit_rules replace the current ones. The key and the status cannot be changed here (use set_automation_status), and emails are changed with set_automation_step. If the automation is on, the change applies to people in it now, and an edit that would leave it unable to send is refused with 422 automation_not_ready. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
namestringнетName shown in the dashboard. (max 200 chars)
audience_labelstringнетWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringнетWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectнетHow people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end.
entry.typestringдаEntry type. (one of event, bucket, date_field, manual)
entry.eventstringнетEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringнетSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringнетContact field key for a date_field entry. (max 40 chars)
entry.reentrystringнетWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectнетWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullнетEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleanнетTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]нетEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegerнетDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectнетPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleanнетSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullнетAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullнетStored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…)
settings.holdout_pctnumberнетPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegerнетAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegerнетHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegerнетPriority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000)
from_namestringнетSender display name, e.g. Acme. (max 120 chars)
from_addressstringнетSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringнетReply-To address. (max 320 chars)
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_automation",
  "arguments": {
    "automation_key": "checkout-recovery",
    "name": "Checkout recovery",
    "settings": {
      "holdout_pct": 10
    }
  }
}
Destructivedelete_automation
DELETE /automations/:automation_key

Delete an automation

DESTRUCTIVE: permanently delete an automation with its emails, language versions, enrolments, send records, and statistics. Only a draft or switched-off automation that nobody is currently in can be deleted; otherwise it fails with 409. Confirm with the user first. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Changes stateset_automation_step
PUT /automations/:automation_key/steps/:position

Create or change an email of an automation

Automations: Create the email at position, or change the fields you pass on the one that is there; fields left out keep their value. If the automation is on, people who have not received this email yet get the new version, so confirm the wording with the user. An existing email keeps its ID: people who already received it are not sent it again. With template, the email becomes that template of the library (see list_automation_templates): its subject, preview text and content replace the email's and its language versions are removed. While the automation is on, an email must keep a subject and content, and may not hold a placeholder of the template library such as [First step] or print a workspace name that is blank (422 automation_not_ready with problems). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerдаPosition of the email in the automation, 1 to 50. (1–50)
templatestringнетId of a template of the library, e.g. welcome-note (not a set). The email becomes that template; other fields passed here are applied on top. The email's wait is not the template's: pass offset_seconds. (max 63 chars)
subjectstringнетSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringнетInbox preview line. (max 300 chars)
contentobjectнетBlock document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html.
htmlstringнетHTML body. The unsubscribe footer is added automatically.
textstringнетТекстовая версия письма.
editorstringнетHow the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design)
offset_secondsintegerнетWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
skip_if_emptystring[]нетMerge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items)
ignore_send_windowbooleanнетSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe email: {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "set_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 2,
    "offset_seconds": 86400,
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p>"
  }
}
Destructivedelete_automation_step
DELETE /automations/:automation_key/steps/:position

Remove an email from an automation

DESTRUCTIVE: remove the email at position from an automation. It is no longer sent or listed; records of who already received it are kept. While the automation is on, its only email cannot be removed (409). Confirm with the user first. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerдаPosition of the email in the automation, 1 to 50. (1–50)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 3
  }
}
Changes stateset_automation_step_variant
PUT /automations/:automation_key/steps/:position/variants/:locale

Create or change a language version of an email

Automations: Save the version of one email for contacts whose locale is this language tag (e.g. fr); a contact with a regional locale such as pt-br gets the pt version when there is no pt-br one. Fields left out keep their value. A version without a body uses the email's own body, and a blank subject or preheader falls back to the email's. Contacts without a matching version get the email as written. If the automation is on, matching contacts who have not received this email yet get this version. While the automation is on, a version may not hold a placeholder of the template library or print a workspace name that is blank (422 automation_not_ready). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerдаPosition of the email in the automation, 1 to 50. (1–50)
localestringдаLanguage tag of the version, e.g. fr or pt-br. (max 35 chars)
subjectstringнетSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringнетInbox preview line. (max 300 chars)
contentobjectнетBlock document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html.
htmlstringнетHTML body. The unsubscribe footer is added automatically.
textstringнетТекстовая версия письма.
Returns{locale, subject, preheader, content, html, text, updated_at}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "set_automation_step_variant",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1,
    "locale": "fr",
    "subject": "Vous hésitez encore ?",
    "html": "<p>Votre panier vous attend.</p>"
  }
}
Sends real emailset_automation_status
POST /automations/:automation_key/status

Turn an automation on or off

SENDS REAL EMAIL when status is on: from then on, everyone who enters the automation is emailed on its schedule, within the workspace's sending limits and hours (get_sending_limits), and people already in it continue. Use preview_automation to see who would get which email. Only turn it on when the user asked for this automation to start. Turning on checks an entry, a goal or exit_rules.no_goal, at least one email with a subject and content, no placeholder of the template library such as [First step] or [Link to plans] left in any email (subject, preview text, body, or a link's address), and no blank workspace name that an email prints (422 automation_not_ready with problems, which names each email and detail; get_automation lists the same under to_fill), a sender on a verified domain (403), and an active subscription (402). off stops new entries and sending; people in it stay and continue if it is turned on again, except that an email more than stale_days overdue by then is skipped. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
statusstringдаon to start sending, off to stop. (one of on, off)
ReturnsThe automation: {id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "set_automation_status",
  "arguments": {
    "automation_key": "checkout-recovery",
    "status": "off"
  }
}
Sends real emailsend_automation_test_email
POST /automations/:automation_key/steps/:position/test

Send one automation email to yourself as a test

SENDS REAL EMAIL: one email of an automation, marked [Test], to the account's own address (get_account -> user.email) and nowhere else; a recipient cannot be given. It is the email as the automation would send it (the language version for locale, the same sender, unsubscribe footer and checks), with stand-in values for its merge tags; sample replaces any of them. A test is not part of the automation: nobody is enrolled, it is in no report, it counts toward nobody's per-person sending limits, it is not tracked, and the automation does not have to be on. It counts toward the workspace's own sending allowance. With dry_run: true nothing is sent and the result is the email as the test would deliver it, with locales and the sample values used. Fails with 422 automation_not_ready when the automation has no sender or the email has no subject or content, and 429 test_limit_reached after 100 test emails in 24 hours. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerдаPosition of the email in the automation, 1 to 50. (1–50)
localestringнетSend the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars)
sampleobjectнетValues to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set.
dry_runbooleanнетSend nothing; return the email as the test would deliver it.
Returns{to, position, locale, subject, id: em_…, status: sent|held}. With dry_run: {dry_run: true, to, from, position, locale, locales, subject, preheader, html, text, sample: [{key, label, value}]}.
Пример параметров tools/call
{
  "name": "send_automation_test_email",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1
  }
}
Sends real emailsend_automation_test
POST /automations/:automation_key/test

Send every email of an automation to yourself as tests

SENDS REAL EMAIL: every email of an automation, in order, marked [Test 1 of 3], [Test 2 of 3] and so on, to the account's own address (get_account -> user.email) and nowhere else, without waiting for the emails' delays. Rendering, footer, checks and stand-in values are as in send_automation_test_email. A test is not part of the automation: nobody is enrolled, it is in no report, it counts toward nobody's per-person sending limits, it is not tracked, and the automation does not have to be on. It counts toward the workspace's own sending allowance. Nothing is sent unless everything can be: a sender, a subject and content on every email (422 automation_not_ready with problems), and room for all of them under 100 test emails in 24 hours (429 test_limit_reached). If a send is refused after others went out, the rest are not tried and each email's outcome is returned. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
localestringнетSend the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars)
sampleobjectнетValues to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set.
Returns{to, data: [{position, locale, subject, id: em_…, status: sent|held|failed, error?}], count, sent, failed, not_sent}.
Пример параметров tools/call
{
  "name": "send_automation_test",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Sends real emailenroll_contact
POST /automations/:automation_key/enroll

Add a contact to an automation

SENDS REAL EMAIL on the automation's schedule: starts the automation for one existing, subscribed contact, counting from anchor_at (now by default). Only call it when the user asked for this person to get this sequence. The automation must be on (409 automation_not_on). Fails with 404 when the email is not a contact (add it with upsert_contact), 422 when the contact cannot be mailed, and 409 when the contact is already in it or went through it before and re-entry is not allowed. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringдаEmail address of an existing contact. (max 320 chars)
propertiesobjectнетUp to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved.
anchor_atstringнетThe moment the emails' offsets count from, ISO 8601 with a time zone. Defaults to now; may lie ahead for emails that lead up to a date. (max 40 chars)
ReturnsThe enrolment: {id, automation_key, contact_id, status, source, is_holdout, anchor_at, entered_at, next_due_at, exit_reason, ended_at, converted_at}.
Пример параметров tools/call
{
  "name": "enroll_contact",
  "arguments": {
    "automation_key": "checkout-recovery",
    "email": "ada@example.net",
    "properties": {
      "plan": "pro"
    }
  }
}
Changes stateexit_contact
POST /automations/:automation_key/exit

Take a contact out of an automation

Automations: End a contact's open enrolment in one automation, so no further emails of it are sent to them. Other automations and broadcasts are not affected, and the contact stays subscribed. Fails with 404 when the contact is not in it. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringдаEmail address of the contact. (max 320 chars)
reasonstringнетWhy, for the record (max 200 chars). Defaults to manual. (max 200 chars)
ReturnsThe ended enrolment: {id, automation_key, contact_id, status, source, is_holdout, anchor_at, entered_at, next_due_at, exit_reason, ended_at, converted_at}.
Пример параметров tools/call
{
  "name": "exit_contact",
  "arguments": {
    "automation_key": "checkout-recovery",
    "email": "ada@example.net",
    "reason": "Asked support to stop"
  }
}
Read-onlypreview_automation
GET /automations/:automation_key/preview

Preview what an automation would send now

Automations: A dry run. For the people in the automation now, in the order they come due, what would happen if each were evaluated at this moment. outcome is send (the email in step would go out), scheduled (nothing is due before until), held (the email waits until until; reason is limit_cap, limit_gap, window, or daily_cap), waiting (behind the higher-priority automation in behind), skip (reason is stale, empty_field, or holdout), exit (the contact can no longer be mailed and would leave), complete, blocked (automation_off or subscription_required), or in_progress. Read-only: nothing is sent or changed. Use it before set_automation_status, or after changing limits, to see who gets which email. It applies the automation's own rules and does not foresee a refusal only a real send meets, such as the workspace's daily sending limit or a paused sender. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{automation_key, status, evaluated_at, data: [{enrollment_id, contact_id, email, status, next_due_at, outcome, reason, until, step: {position, subject, locale}, behind: {key, name}, superseded}], count, counts, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "preview_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlyget_automations_overview
GET /automations/overview

Get results across all automations

Automations: What every automation of the workspace did in a date range (the last 30 days by default, at most 366 days): totals and one entry per day for people who entered, emails sent, delivered, opened, clicked, and converted (a goal event credited to an email), plus bounces, complaints, unsubscribes, and held (emails made to wait by a limit). Days on which nothing happened are in the series with zeros. domain narrows it to the automations that send from one domain (none: those with no sender yet). Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
fromstringнетFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringнетLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
domainstringнетOnly the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars)
Returns{from, to, totals: {entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}, series: [{day, entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_automations_overview",
  "arguments": {
    "from": "2026-10-20",
    "to": "2026-11-18"
  }
}
Read-onlyget_automation_report
GET /automations/:automation_key/report

Get the results of one automation

Automations: The results of one automation in a date range (the last 30 days by default, at most 366 days): the same totals and daily series as get_automations_overview, and steps, one row per email with what it sent and what came of it. An email that was removed is listed with archived: true while it still has numbers in the range. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
fromstringнетFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringнетLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
Returns{automation: {key, name, status, goal_label}, from, to, totals, series: [{day, ...}], steps: [{step_id, position, subject, offset_seconds, archived, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}]}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_automation_report",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlylist_automation_people
GET /automations/:automation_key/people

List the people in an automation

Automations: One row per person who did did in an automation, most recent first: entered (the default: everyone who was ever in it), sent, delivered, opened, clicked, converted (their goal was credited to an email), bounced, unsubscribed, or waiting (waiting now behind a higher-priority automation). step narrows every filter except entered and waiting to one email. Each row has the contact's email and name, when they did it, their enrolment's status, and latest: the most recent thing that happened to them in the automation. counts says how many people each filter would list. Read one person's full history with get_automation_person. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
didstringнетWhat the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting)
stepintegerнетOnly this email of the automation, by its position. (1–50)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{automation_key, did, step, data: [{contact_id, email, name, contact_status, enrollment_id, enrollment_status, at, latest: {did, at, step_position, reason}}], count, next_cursor, counts, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_automation_people",
  "arguments": {
    "automation_key": "checkout-recovery",
    "did": "clicked"
  }
}
Read-onlyget_automation_person
GET /automations/:automation_key/people/:contact_id

Get one person's history in an automation

Automations: Everything that happened to one contact in an automation: each enrolment and how it ended, each email with when it was sent, delivered, first opened, first clicked, bounced, complained about, or unsubscribed from, every open and click on it (machine: true marks an automated request, which is not counted), and the conversion with the email it was credited to. Fails with 404 for a contact that was never in the automation. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
automation_keystringдаAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
contact_idstringдаContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Returns{automation_key, contact: {id, email, name, status}, enrollments: [{id, status, source, is_holdout, anchor_at, entered_at, next_due_at, last_sent_at, exit_reason, ended_at, converted_at, converted_send_id}], sends: [{id, enrollment_id, step_id, step_position, subject, status, skip_reason, locale, email_id, sent_at, delivered_at, opened_at, clicked_at, bounced_at, complained_at, unsubscribed_at, converted_at, open_count, machine_open_count, click_count, events: [{kind, machine, reason, position, url, country, at}]}], conversion: {enrollment_id, converted_at, goal_event, send_id, step_position}}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_automation_person",
  "arguments": {
    "automation_key": "checkout-recovery",
    "contact_id": "ct_123"
  }
}
Read-onlyget_sending_limits
GET /automation-settings

Get automation sending limits

Automations: How much automation email one person may get across every automation, and when: at most max_emails in any period_days, at least min_gap_hours apart, only between window_start and window_end (hours in the contact's time zone, or default_timezone) on weekdays (0 = Sunday to 6 = Saturday). An email that would break a limit is not dropped: it waits until the limits allow it. Also product_name and sender_name, available to every automation email as merge tags. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

Без параметров.

Returns{max_emails, period_days, min_gap_hours, window_start, window_end, weekdays, default_timezone, product_name, sender_name, updated_at}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_sending_limits",
  "arguments": {}
}
Changes stateupdate_sending_limits
PUT /automation-settings

Update automation sending limits

Automations: Change the workspace's per-person limits and sending hours for automation email. Omitted keys keep their value. Looser limits mean people can get more email, sooner: confirm with the user before raising max_emails, shortening min_gap_hours, or widening the hours. product_name and sender_name are the names the emails of the template library print; one that an automation that is on prints cannot be cleared (409 workspace_name_in_use). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
max_emailsintegerнетMost automation emails one person may get in period_days. Default 2. (1–50)
period_daysintegerнетThe period max_emails applies to, in days. Default 7. (1–90)
min_gap_hoursintegerнетLeast time between two automation emails to one person, in hours. Default 44. (0–720)
window_startintegerнетFirst hour of the day emails may go out, local time (0-23). Default 9. (0–23)
window_endintegerнетHour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24)
weekdaysinteger[]нетDays emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items)
default_timezonestringнетIANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars)
product_namestringнетYour product's name, for {{ product_name }}. (max 120 chars)
sender_namestringнетWho the emails are from, for {{ sender_name }}. (max 120 chars)
ReturnsThe updated limits.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_sending_limits",
  "arguments": {
    "max_emails": 3,
    "min_gap_hours": 24,
    "default_timezone": "Europe/London"
  }
}
Read-onlylist_automation_templates
GET /automation-library

List automation templates

Automations: The template library: ready-made lifecycle emails to start an automation from instead of writing one. It covers welcome, onboarding tips, a nudge to finish setup (activation), trial ending and trial ended, abandoned checkout, failed payment (dunning), receipt, upgrade at a usage limit, feature announcement, review request, feedback score (NPS), cancellation survey, and winback for retention. Each template has a name, a one-line purpose, the goal it serves (group), its subject, the merge tags it prints, and start: the suggested entry event, the email's wait, and the goal event that ends the automation for a person. sets are templates that arrive together as one automation: three onboarding tips, trial ending then trial ended, and payment failed then a last notice. fill_in lists what only the user knows: placeholders in square brackets such as [First step] or [Link to plans], and the workspace names the email prints. Email bodies are not included; use get_automation_template. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{version, groups, data: [{id, kind, name, purpose, group, set, subject, preview_text, needs_consent, start: {entry, offset_seconds, goal_event, goal_label, skip_if_empty}, merge_keys, fill_in: [{kind, key, placeholder, label, example}]}], sets: [{id, kind, name, purpose, group, needs_consent, emails: [{template, offset_seconds}], start, merge_keys, fill_in}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_automation_templates",
  "arguments": {}
}
Read-onlyget_automation_template
GET /automation-library/:template_id

Get an automation template

Automations: One template or one set of the template library, as the draft automation it would make: the suggested start and goal, what the user must fill in, and every email in order with its wait, subject, the email as a block document (content), and preview: the subject and text as this workspace would send them, with sample values for the merge tags. Read it to show the user a welcome, onboarding, trial, abandoned checkout, failed payment (dunning), upgrade, cancellation or winback email before using it. Placeholders such as [First step] are shown as written; a workspace name that is not set reads "Your product" or "Your name" in the preview. Then use_automation_template makes the draft, or set_automation_step with template loads one email into an existing automation. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
template_idstringдаId of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars)
Returns{id, kind (email or set), name, purpose, group, set, needs_consent, start: {entry, goal_event, goal_label}, merge_keys, fill_in: [{kind, key, placeholder, label, example}], emails: [{template, name, offset_seconds, skip_if_empty, subject, preview_text, content, preview: {subject, preheader, text, html}}]}. preview.html is null.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_automation_template",
  "arguments": {
    "template_id": "welcome-note"
  }
}
Changes stateuse_automation_template
POST /automation-library/:template_id/use

Create an automation from a template

Automations: Create a draft automation from a template or a set of the library, ready-made: a welcome email, three onboarding tips, a nudge to finish setup, trial ending and trial ended, abandoned checkout, failed payment (dunning) notices, a receipt, an upgrade email at a usage limit, a feature announcement, a review request, a feedback score, a cancellation survey, or a winback for retention. The draft has the emails, the suggested entry event and the suggested goal. Nothing is sent: it stays a draft until set_automation_status turns it on, and that is refused while anything in to_fill is left. to_fill lists each placeholder to replace, by email (ask the user for the real words and links, then use set_automation_step), and each workspace name the emails print that is blank (product_name, sender_name: set with update_sending_limits). Make sure the entry event is one the workspace records (list_event_names); change the start with update_automation. from_address must be on a verified domain. Fails with 404 for an unknown template and 409 when key is taken. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
template_idstringдаId of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars)
keystringнетAddress of the new automation: 1-63 characters of a-z, 0-9, and -. Defaults to the template's id, with a number added when that is taken. (max 63 chars)
namestringнетName shown in the dashboard. Defaults to the template's own name. (max 200 chars)
from_namestringнетSender display name, e.g. Acme. (max 120 chars)
from_addressstringнетSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringнетReply-To address. (max 320 chars)
ReturnsThe new automation (status draft) with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), merge_fields [{key, label}], template, and to_fill [{id, position, locale, where, placeholder, key, message}]: what must be filled in before it can be turned on.
Пример параметров tools/call
{
  "name": "use_automation_template",
  "arguments": {
    "template_id": "welcome-note",
    "name": "Welcome",
    "from_name": "Dana from Acme",
    "from_address": "dana@example.com"
  }
}
Read-onlylist_events
GET /events

List what contacts did

Automations: The events recorded for the workspace, newest first: who (the contact's id, email, and name), what they did (the event name, and the same as words), when, its properties, where it came from (source.type: api for the workspace's own code, connection with the connection's name, upload for a spreadsheet, system for SendHQ itself), and effects: the automations it started, ended, or converted for that contact. Filter by contact (a contact ID or an email address), name (one event name), and from / to. With contact, the result also lists every automation that contact is or was in (enrollments). An event being recorded does not mean an email was sent: check the automation with list_automation_people. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
contactstringнетOnly this contact: a contact ID or an email address. (max 320 chars)
namestringнетOnly this event, e.g. checkout_started. See list_event_names. (max 64 chars)
fromstringнетEvents from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars)
tostringнетEvents up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars)
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{id, contact: {id, email, name}, event, words, occurred_at, received_at, source: {type, label, connection_id}, properties, effects: [{did, automation_key, automation_name}]}], count, next_cursor, enrollments (with contact), pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_events",
  "arguments": {
    "name": "checkout_started",
    "from": "2026-11-01"
  }
}
Read-onlylist_event_names
GET /events/names

List the kinds of event recorded

Automations: Every distinct event name recorded in the last 30 days with how many times, the most frequent first, each with the name as words (checkout_started reads checkout started). Use it to see what the workspace is being told about before creating an automation that starts on an event. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{event, words, count}], count, days, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_event_names",
  "arguments": {}
}
Read-onlylist_connections
GET /connections

List connections

Automations: The workspace's connections. A connection is a secret address another system posts to, such as a payment provider's webhook; what arrives is recorded as events, exactly as track_event records them. Each has its kind (stripe, dodo, or generic), whether it is enabled, whether a signing secret is set, the last four characters of its address, and last_delivery in plain words such as "Recorded 2 events" or "Refused: bad signature". The address and the signing secret are never returned here. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Returns{data: [{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery {id, at, result, reason, recorded, events, text, provider_event, email}], count, limit, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_connections",
  "arguments": {}
}
Read-onlyget_connection
GET /connections/:connection_id

Get a connection and its last deliveries

Automations: One connection with its last 50 deliveries, newest first: when each arrived, whether it was recorded, skipped, or refused and why (text says it in plain words), the sender's own event type, the names of the events recorded, and the contact's email address. Payloads are not stored. Use it to find out why something a provider sent did not show up. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
connection_idstringдаConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery and deliveries: [{id, at, result, reason, recorded, events, text, provider_event, email}].
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}
Sends real emailcreate_connection
POST /connections

Create a connection

SENDS REAL EMAIL later, when an automation is listening: from the moment the address this returns is given to another system, everything that system posts is recorded as events without anyone looking, and a recorded event starts every automation that is on and starts on it. Only create one when the user asked to connect that system. Returns address once; it cannot be read again, so hand it to the user at once. kind is stripe or dodo (mapped for you: checkout_completed, checkout_abandoned, paid, payment_failed, subscription_started, subscription_renewed, subscription_cancelled, plan_changed) or generic with a mapping. consent_basis is recorded on every contact the connection creates. The provider's signing secret is set by a person in the dashboard or with the REST API, not here. A workspace may have 10 connections (409 connection_limit_reached). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
namestringдаWhat to call it, e.g. Stripe. (max 80 chars)
kindstringдаstripe, dodo, or generic. (one of generic, stripe, dodo)
consent_basisstringдаHow the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars)
event_prefixstringнетPut in front of every event name, e.g. stripe_. (max 32 chars)
enabledbooleanнетDefaults to true. Pass false to create it switched off.
mappingobjectнетFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringнетWhere the contact's email address is. (max 120 chars)
mapping.eventstringнетWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringнетOne fixed event name, instead of event. (max 64 chars)
mapping.timestringнетWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringнетWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]нетThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus address (shown once) and last_delivery: null.
Пример параметров tools/call
{
  "name": "create_connection",
  "arguments": {
    "name": "Stripe",
    "kind": "stripe",
    "consent_basis": "Bought a plan on acme.com and accepted product emails"
  }
}
Sends real emailupdate_connection
PATCH /connections/:connection_id

Change a connection or switch it on or off

SENDS REAL EMAIL later when enabled is set to true: what the connected system posts is recorded as events again, and a recorded event starts every automation that is on and starts on it. Only switch one on when the user asked. Also changes name, consent_basis, event_prefix, or a generic connection's mapping. While enabled is false the address answers 404 and records nothing. The kind cannot be changed. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
connection_idstringдаConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
namestringнетA new name. (max 80 chars)
enabledbooleanнетtrue: record what arrives. false: answer 404 and record nothing.
consent_basisstringнетHow the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars)
event_prefixstringнетPut in front of every event name, e.g. stripe_. (max 32 chars)
mappingobjectнетFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringнетWhere the contact's email address is. (max 120 chars)
mapping.eventstringнетWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringнетOne fixed event name, instead of event. (max 64 chars)
mapping.timestringнетWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringнетWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]нетThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at}.
АннотацииidempotentHint
Пример параметров tools/call
{
  "name": "update_connection",
  "arguments": {
    "connection_id": "acn_123",
    "enabled": false
  }
}
Destructivedelete_connection
DELETE /connections/:connection_id

Delete a connection

DESTRUCTIVE: permanently delete a connection with its delivery records. Its address stops working at once, so the system that posts to it starts getting 404 and nothing more is recorded from it. The events it already recorded stay. Confirm with the user first; to pause one instead, use update_connection with enabled: false. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.

ПараметрТипОбязательнаОписание
connection_idstringдаConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Возвращает{ok: true}.
АннотацииdestructiveHint idempotentHint
Пример параметров tools/call
{
  "name": "delete_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}

Аккаунт, использование, аналитика и ключи

Только чтениеget_account
GET /account

Получить аккаунт, использование и оплату

Email владельца аккаунта, тариф/уровень доступа, использованные в текущем периоде доставки получателям в сравнении с квотой, использованные домены в сравнении с лимитом, объём передачи вложений, сводка по репутации, состояние подписки, опубликованные тарифы и счётчики рабочего пространства. Используйте, чтобы проверить оставшуюся квоту или на какой адрес можно доставлять письма в пробном периоде (email аккаунта).

Без параметров.

Возвращает{user: {email, …}, usage: {domainsUsed, domainLimit, recipientDeliveries, emailQuotaMonth, attachmentBytes, attachmentByteLimit, periodKey}, access: {tier, planCode}, reputation, infrastructure, billing: {status, subscriptions, …}, plans, workspace: {mailer, stats}}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_account",
  "arguments": {}
}
Read-onlyget_account_diagnostics
GET /account/diagnostics

Diagnose sending and receiving

One read that explains what is wrong with sending or receiving in this workspace: an issues list (unverified domains and missing DKIM records, inbound MX not ready, paused or throttled senders, quota or daily limit reached, trial restrictions, high bounce or complaint rates, failing webhooks), plan and usage against limits, each domain with its DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, and the last 30 days of messages that were not sent (with reasons) plus bounce, complaint and reject events. Start here when a user asks why mail is not arriving. Never returns message bodies or secrets.

Без параметров.

Returns{generatedAt, windowDays, issues: [{severity, code, message}], plan: {tier, usage, sendingLimit}, domains: [{name, status, dkim: {required, verified, missing}, inbound}], sendingIdentities, inbound, deliverability: {sent, delivered, bounced, complained, rates, senders}, suppressions: {total, byReason, unsubscribes, recent}, failures: {notSent, recentNotSent, recentProviderEvents}, webhooks}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_account_diagnostics",
  "arguments": {}
}
Только чтениеget_analytics
GET /analytics

Получить аналитику отправки

Аналитика панели управления за последние 7, 30 или 90 дней: итоги по отправленным, полученным, доставленным, отказам, заблокированным, открытиям, кликам и жалобам, ежедневная динамика, основные домены отправки и самые частые темы.

ПараметрТипОбязательнаОписание
daysintegerнетОкно в днях: 7, 30 (по умолчанию) или 90. (одно из 7, 30, 90)
Возвращает{window, days, metrics, timeline: [{day, sent, received}], domains, topContent}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_analytics",
  "arguments": {
    "days": 30
  }
}
Только чтениеlist_api_keys
GET /keys

Метаданные API-ключей

Список имён API-ключей, несекретных префиксов и времени последнего использования. Только чтение: этот MCP-сервер не может создавать, ротировать или отзывать ключи; это делает человек в панели управления. Результат разбит на страницы: он содержит pagination {offset, limit, returned, total?, has_more, next_offset}.

ПараметрТипОбязательнаОписание
limitintegerнетРазмер страницы. По умолчанию 50. (по умолчанию 50; 1–200)
offsetintegerнетКоличество пропускаемых записей. Используйте pagination.next_offset из предыдущей страницы. (по умолчанию 0; 0–…)
Возвращает{data: [{id, name, prefix, lastUsedAt, createdAt}], count, pagination}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "list_api_keys",
  "arguments": {}
}
Только чтениеget_service_health
GET /health

Проверить работоспособность сервиса SendHQ

Проверяет, что API SendHQ работает, и какой почтовый провайдер активен. Действительный API-ключ не нужен.

Без параметров.

Возвращает{ok, service, mailer}.
АннотацииreadOnlyHint idempotentHint
Пример параметров tools/call
{
  "name": "get_service_health",
  "arguments": {}
}

Покрытие API

Все операции публичного API и инструменты, которые их покрывают. Покрыто всё, что пользователь может сделать в панели управления и для чего есть API; перечисленные ниже исключения сделаны намеренно.

ЭндпоинтИнструментПримечания
POST /emailssend_emailОтправить одно письмо
POST /emails/batchsend_batchОтправить до 100 индивидуальных писем
GET /emailslist_emailsСписок отправленных и полученных писем
GET /emails/:idget_emailПолучить письмо и его вложения
PATCH /emails/:idmark_emailИзменить статус прочтения, архивации, спама, категорию или важность
POST /emails/:id/labelslabel_emailДобавить или снять метки с письма
DELETE /emails/:iddelete_emailУдалить сохранённое письмо
GET /emails/:id/eventslist_email_eventsСписок событий доставки письма
GET /threads/:idget_threadПолучить переписку в хронологическом порядке
GET /labelslist_labelsСписок меток с количеством писем и правилами сортировки
POST /labelscreate_labelСоздать метку, при необходимости с правилами автосортировки
GET /labels/:idget_labelПолучить метку по ID или имени
PATCH /labels/:idupdate_labelПереименовать метку, изменить её цвет или превратить в группу
DELETE /labels/:iddelete_labelУдалить метку, не удаляя её письма
POST /labels/:id/rulescreate_label_ruleДобавить к метке правило автосортировки
DELETE /labels/:id/rules/:rule_iddelete_label_ruleУдалить правило автосортировки
POST /draftscreate_draftСоздать черновик в редакторе
GET /draftslist_draftsСписок черновиков редактора
GET /drafts/:idget_draftПолучить черновик и вложения
PUT /drafts/:idupdate_draftЗаменить содержимое черновика
DELETE /drafts/:iddelete_draftУдалить черновик
POST /drafts/:id/attachmentsupload_attachmentЗагрузить вложение в черновик
GET /attachments/:iddownload_attachmentСкачать закрытое вложение
DELETE /attachments/:iddelete_attachmentУдалить закрытое вложение
GET /sending-identitieslist_sending_identitiesСписок подтверждённых адресов отправителя
GET /templateslist_templatesСписок хранимых шаблонов
POST /templatescreate_templateСоздать хранимый шаблон
GET /templates/:idget_templateПолучить черновики, релизы и статистику использования
PUT /templates/:id/draftupdate_template_draftАвтосохранение черновика шаблона
POST /templates/:id/draftcreate_template_draftСоздать новый черновик на основе опубликованного релиза
POST /templates/:id/renderrender_templateОтрендерить точный результат на сервере
POST /templates/:id/testsend_template_testОтправить тестовый снимок
POST /templates/:id/publishpublish_templateОпубликовать неизменяемый релиз шаблона
POST /templates/:id/archivearchive_templateАрхивировать шаблон
POST /templates/:id/restorerestore_templateВосстановить шаблон из архива
POST /domainsadd_domainДобавить домен отправки
GET /domainslist_domainsСписок доменов и кешированное состояние DNS
GET /domains/:idget_domainПолучить параметры настройки домена
POST /domains/:id/verifyverify_domainRefresh domain and DNS verification
POST /domains/:id/inbound/setupsetup_inboundProvision inbound receiving
POST /domains/:id/inbound/verifyverify_inboundПроверить маршрутизацию входящей почты по MX
DELETE /domains/:iddelete_domainУдалить домен
GET /dns/providerget_dns_providerОпределить авторитетного DNS-провайдера и относительные хосты записей
GET /dns/domain-connect/connectget_domain_connect_linkСоздать ссылку согласия Domain Connect для настройки DNS в один клик
POST /inboxescreate_inboxСоздать входящий адрес
GET /inboxeslist_inboxesСписок входящих адресов
GET /inboxes/:idget_inboxПолучить входящий адрес
PATCH /inboxes/:idupdate_inboxПереименовать, включить или отключить почтовый ящик
PUT /inboxes/:id/forwardingset_inbox_forwardingПересылать полученные письма почтового ящика на другой адрес
DELETE /inboxes/:iddelete_inboxУдалить почтовый ящик с сохранением писем
GET /deliverability/statsdeliverability_statsПолучить статистику доставки за 30 дней
GET /deliverability/reputationlist_sender_reputationСостояние репутации по точному адресу отправителя
GET /deliverability/accountdeliverability_accountAccount delivery rates, daily ladder, and bounce trend
GET /deliverability/domainsdeliverability_domainsPer-domain sent, delivered, hard and soft bounces, complaints, and failures
GET /deliverability/sendersdeliverability_sendersPer-From-address delivery rates
POST /deliverability/scorescore_emailScore an email's content before it is sent
GET /emails/:id/deliveryemail_deliveryDelivery timeline for one email, with bounce and complaint reasons
GET /threads/:id/deliverythread_deliveryPer-thread delivery counts and per-message failure reasons
GET /suppressionslist_suppressionsСтоп-лист рабочего пространства
DELETE /suppressions/:emailremove_suppressionУдалить из стоп-листа допустимую запись об отказе
GET /blocked-recipientslist_blocked_recipientsСписок отказов, жалоб и отписок
GET /webhooksне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
POST /webhooksне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /webhooks/:idне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
PATCH /webhooks/:idне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
DELETE /webhooks/:idне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
POST /webhooks/:id/rotate-secretне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
POST /webhooks/:id/testне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /webhooks/:id/deliveriesне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /webhooks/:id/deliveries/:deliveryIdне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
POST /webhooks/:id/deliveries/:deliveryId/retryне предоставляетсяWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /contactslist_contactsList contacts
POST /contactscreate_contactAdd a contact with its consent basis
PUT /contactsupsert_contactCreate or update a contact by email
POST /contacts/bulkbulk_update_contactsTag, move, unsubscribe, or delete many contacts at once
GET /contacts/exportне предоставляетсяImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /contacts/:idget_contactRetrieve a contact by ID or email
PATCH /contacts/:idupdate_contactUpdate a contact's name, fields, or tags, or unsubscribe it
DELETE /contacts/:iddelete_contactDelete a contact and its list memberships
POST /contact-importsimport_contactsImport contacts from CSV
GET /contact-importslist_contact_importsList recent contact imports
GET /tagslist_tagsList contact tags with how many contacts carry each
GET /contact-fieldslist_contact_fieldsList custom contact field definitions
PUT /contact-fields/:keyset_contact_fieldDefine or change a custom contact field
DELETE /contact-fields/:keydelete_contact_fieldDelete a custom field definition
GET /segmentslist_segmentsList saved segments with live counts
POST /segmentscreate_segmentSave a segment
POST /segments/previewpreview_segmentCount and sample the contacts that match unsaved conditions
GET /segments/:idget_segmentRetrieve a segment and its live count
PATCH /segments/:idupdate_segmentRename a segment or change its conditions
DELETE /segments/:iddelete_segmentDelete a segment
GET /listslist_listsList contact lists with member counts
POST /listscreate_listCreate a list with an optional signup form, welcome email, and newsletter site
GET /lists/:idget_listRetrieve a list
PATCH /lists/:idupdate_listRename a list or change its signup form, welcome email, or site
DELETE /lists/:iddelete_listDelete a list without deleting its contacts
POST /lists/:id/contactsadd_list_contactsAdd existing contacts to a list
DELETE /lists/:id/contacts/:contact_idremove_list_contactRemove a contact from a list
GET /broadcastslist_broadcastsList broadcasts
POST /broadcastscreate_broadcastCreate a broadcast draft
GET /broadcasts/:idget_broadcastRetrieve a broadcast and its delivery totals
PATCH /broadcasts/:idupdate_broadcastEdit a draft broadcast
DELETE /broadcasts/:iddelete_broadcastDelete a draft broadcast
GET /broadcasts/:id/checkscheck_broadcastRun the pre-send checks for a broadcast
POST /broadcasts/:id/testsend_broadcast_testSend a test copy of a draft
POST /broadcasts/:id/scheduleschedule_broadcastSchedule a draft to send later
POST /broadcasts/:id/unscheduleunschedule_broadcastUnschedule a draft
POST /broadcasts/:id/duplicateduplicate_broadcastCopy a broadcast into a new draft
POST /broadcasts/:id/sendsend_broadcastSend a broadcast to its audience
POST /broadcasts/:id/send-moresend_broadcast_to_moreSend a sent broadcast to more of its audience
POST /broadcasts/:id/cancelcancel_broadcastCancel a draft or sending broadcast
GET /broadcasts/:id/recipientslist_broadcast_recipientsList a broadcast's recipients, outcomes, and engagement
GET /broadcasts/:id/reportget_broadcast_reportRetrieve a broadcast's engagement report
GET /campaigns/overviewget_campaign_overviewRetrieve subscriber growth and recent broadcast performance
GET /newsletter-settingsget_newsletter_settingsRetrieve newsletter settings
PATCH /newsletter-settingsupdate_newsletter_settingsChange newsletter settings
POST /uploads/imagesне предоставляетсяImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /uploads/imageslist_uploaded_imagesList recently uploaded images
POST /eventstrack_eventRecord something a contact did
POST /events/batchне предоставляетсяHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automationslist_automationsList automations with their 30-day totals
POST /automationscreate_automationCreate an automation as a draft
GET /automations/:keyget_automationRetrieve an automation with its emails
PATCH /automations/:keyupdate_automationEdit an automation
DELETE /automations/:keydelete_automationDelete an automation and its history
PUT /automations/:key/steps/:positionset_automation_stepCreate or change one email of an automation
DELETE /automations/:key/steps/:positiondelete_automation_stepRemove one email from an automation
PUT /automations/:key/steps/:position/variants/:localeset_automation_step_variantCreate or change a language version of an email
POST /automations/:key/steps/:position/testsend_automation_test_emailSend one email of an automation to yourself as a test
POST /automations/:key/testsend_automation_testSend every email of an automation to yourself as tests
POST /automations/:key/statusset_automation_statusTurn an automation on or off
POST /automations/:key/enrollenroll_contactAdd a contact to an automation
POST /automations/:key/exitexit_contactTake a contact out of an automation
GET /automations/:key/previewpreview_automationDry run: what each person in an automation would get now
GET /automations/overviewget_automations_overviewTotals and a daily series across every automation
GET /automations/:key/reportget_automation_reportResults of one automation, with one row per email
GET /automations/:key/peoplelist_automation_peopleList the people in an automation by what they did
GET /automations/:key/people/:contact_idget_automation_personOne person's history in an automation
POST /automations/:key/import-historyне предоставляетсяHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automation-settingsget_sending_limitsRetrieve the workspace's sending limits for automations
PUT /automation-settingsupdate_sending_limitsChange the workspace's sending limits for automations
GET /automation-librarylist_automation_templatesList the template library: ready-made lifecycle emails
GET /automation-library/:idget_automation_templateRead one template or set, with the email as it will look
POST /automation-library/:id/useuse_automation_templateCreate a draft automation from a template or set
GET /eventslist_eventsList what contacts did, newest first
GET /events/nameslist_event_namesList the kinds of event recorded in the last 30 days
POST /events/previewне предоставляетсяThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connectionslist_connectionsList the workspace's connections (incoming webhooks)
POST /connectionscreate_connectionCreate a connection and get its address
POST /connections/testне предоставляетсяThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connections/:idget_connectionRetrieve a connection with its last deliveries
PATCH /connections/:idupdate_connectionChange a connection or switch it on or off
DELETE /connections/:iddelete_connectionDelete a connection
POST /connections/:id/addressне предоставляетсяThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
GET /accountget_accountПолучить аккаунт, использование, состояние оплаты и счётчики рабочего пространства с помощью API-ключа
GET /account/diagnosticsget_account_diagnosticsDiagnose sending and receiving problems in the workspace
GET /analyticsget_analyticsПолучить аналитику отправки из панели управления за 7, 30 или 90 дней
GET /profileget_accountДвойник GET /account, доступный только в сессии; MCP-сервер читает маршрут с API-ключом.
POST /billing/checkoutне предоставляетсяИзменения оплаты намеренно доступны только в сессии и требуют действия владельца аккаунта в панели управления. Состояние оплаты можно прочитать через get_account.
POST /billing/cancelне предоставляетсяИзменения оплаты намеренно доступны только в сессии и требуют действия владельца аккаунта в панели управления. Состояние оплаты можно прочитать через get_account.
POST /keysне предоставляетсяНамеренно исключено: агент не должен выпускать или уничтожать учётные данные. Ключами управляет человек в панели управления.
GET /keyslist_api_keysСписок метаданных API-ключей
DELETE /keys/:idне предоставляетсяНамеренно исключено: агент не должен выпускать или уничтожать учётные данные. Ключами управляет человек в панели управления.

Намеренно недоступно

ВозможностьЭндпоинтыПричина
Создание, ротация, отзыв или удаление API-ключейPOST /keys, DELETE /keys/:idНамеренно исключено: агент не должен выпускать или уничтожать учётные данные. Ключами управляет человек в панели управления.
Оформление оплаты или отмена подпискиPOST /billing/checkout, POST /billing/cancelИзменения оплаты намеренно доступны только в сессии и требуют действия владельца аккаунта в панели управления. Состояние оплаты можно прочитать через get_account.
Настройка DNS Cloudflare в один клик (OAuth)GET /api/dns/cloudflare/connectТребует интерактивной сессии в браузере и согласия через OAuth Cloudflare. Вместо этого используйте записи из get_domain, хосты из get_dns_provider или get_domain_connect_link.
Регистрация, вход, выход, привязка аккаунта Google/api/auth/*Аутентификация человека в браузере; MCP-сервер аутентифицируется с помощью API-ключа.
Форма обращения в поддержкуPOST /api/contactПубличная форма на маркетинговом сайте для людей, а не операция рабочего пространства.
Webhook endpoints and deliveriesGET /webhooks, POST /webhooks, GET /webhooks/:id, PATCH /webhooks/:id, DELETE /webhooks/:id, POST /webhooks/:id/rotate-secret, POST /webhooks/:id/test, GET /webhooks/:id/deliveries, GET /webhooks/:id/deliveries/:deliveryId, POST /webhooks/:id/deliveries/:deliveryId/retryWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
Upload editor images and export contacts as CSVPOST /uploads/images, GET /contacts/exportImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
Import an automation's send history and record events in bulkPOST /automations/:key/import-history, POST /events/batchHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
Move SendHQ's own win-back emails onto automations (backfill and comparison)POST /automations/platform-backfill, GET /automations/platform-compareInternal cutover tools for SendHQ's own workspace only: they answer nobody else, need its owner's dashboard session, and are not part of the public API or of /api/v1. The backfill enrols SendHQ's own accounts, so it is run by a person, one page at a time, after reading the dry run.
Replace a connection's secret addressPOST /connections/:id/addressThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
Dry runs for a sample payload and for a set of eventsPOST /connections/test, POST /events/previewThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.

Машиночитаемый каталог: /docs/mcp/tools.json (схемы, аннотации, соответствие эндпоинтам, исключения). Версия этой страницы в Markdown: /docs/mcp.md. Если установлен CLI, команда sendhq commands --format json выводит тот же каталог.