Para agentes de IA

Servidor MCP do 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
Instalar e conectar (Claude Code)
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp

O que é este servidor

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.

É um servidor stdio local, embutido no binário da CLI sendhq. Seu cliente MCP inicia sendhq mcp como processo filho e fala JSON-RPC por stdin/stdout. Cada chamada de ferramenta vira uma requisição documentada à API REST do SendHQ em https://sendhq.cc/api/v1, autenticada com a chave de API do seu workspace; portanto, o servidor MCP tem exatamente as permissões dessa chave e nenhuma a mais.

  • 142 tools in 10 groups, generated from one catalog that is also published as tools.json.
  • JSON Schemas estritos: argumentos desconhecidos, tipos errados e campos obrigatórios ausentes são rejeitados localmente, antes de qualquer coisa chegar ao SendHQ.
  • Erros estruturados com um code estável, o status HTTP, uma explanation, um remedy concreto e a indicação de que tentar novamente pode ajudar ou não.
  • Toda ferramenta que envia e-mail real ou destrói dados avisa isso nas primeiras palavras da descrição e traz anotações de segurança do MCP.
  • O modo --read-only oculta todas as ferramentas de envio e de alteração.
  • Nada é registrado em log. O stdout carrega apenas mensagens do protocolo; a chave de API e o conteúdo das mensagens nunca chegam a um log.
Não é o endpoint MCP da documentação.O SendHQ também hospeda um pequeno endpoint MCP de documentação, somente leitura, em https://sendhq.cc/api/mcp (consulta de preços e documentação, sem acesso à conta). O servidor desta página é o completo, com escopo de conta; ele roda localmente ou como o conector hospedado abaixo.

Use SendHQ in Claude, ChatGPT and Grok

Não é preciso instalar nada: o SendHQ também executa este servidor como conector hospedado em https://mcp.sendhq.cc/mcp, com as mesmas ferramentas. Você entra com sua conta do SendHQ em vez de colar uma chave.

Claude

  1. Abra Settings → Connectors e encontre o SendHQ no diretório, ou escolha Add custom connector e cole https://mcp.sendhq.cc/mcp.
  2. Clique em Connect, entre no SendHQ, revise o acesso e clique em Allow.
  3. Peça ao Claude para verificar sua caixa de entrada, enviar um e-mail do seu domínio verificado ou explicar um bounce.

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.

Aprovação e desconexão

  • The request_feature tool sends a feature request to the SendHQ team with your account details, so we can follow up by email.
  • As ferramentas que enviam e-mail real ou excluem dados são identificadas como tal. Se o assistente pergunta antes é uma configuração por ferramenta no próprio assistente: no Claude, escolha Needs approval para essas ferramentas em Settings → Connectors → SendHQ.
  • O conector recebe a própria chave de API, com o nome do assistente (por exemplo, “Claude (AI connector)”). Exclua-a em API Keys para desconectar imediatamente.
  • Ele não pode criar nem revogar chaves de API, nem alterar a cobrança. Os anexos são enviados e retornados em base64; não há acesso a arquivos locais.
  • Sending requires an active subscription. There is no free allowance, including mail to the account owner.

Dúvidas: postmaster@sendhq.cc. Privacidade: sendhq.cc/privacy.

Instalação

Instale o binário sendhq (Linux, macOS e Windows em x86-64 e arm64). O instalador verifica o checksum da versão e coloca o binário em ~/.local/bin por padrão.

macOS e Linux
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
Windows PowerShell
irm https://downloads.sendhq.cc/install.ps1 | iex
Verifique a instalação
sendhq version
SENDHQ_API_KEY=re_your_key sendhq doctor

Crie uma chave de API no painel em https://sendhq.cc/app#/keys. O servidor MCP não pode criar chaves. O único comando que executa o servidor é:

Execute o servidor stdio
SENDHQ_API_KEY=re_your_key sendhq mcp

Normalmente você nunca o executa manualmente: o cliente MCP o inicia. Quando executado em um terminal, ele fica aguardando JSON-RPC no stdin.

Configure seu cliente

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

Adicione --scope user para disponibilizá-lo em todos os projetos, ou --scope project para gravá-lo no .mcp.json do projeto. Em um .mcp.json compartilhado, referencie a chave pelo ambiente em vez de fazer commit dela; o Claude Code expande ${VAR} no .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" }

Ou pela linha de comando: codex mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp.

Claude Desktop

Edite claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\) e reinicie o app. Aplicativos de desktop não herdam o PATH do seu shell; use o caminho absoluto do binário (which sendhq).

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

Qualquer outro cliente MCP

Configure um servidor stdio com o comando sendhq, os argumentos ["mcp"] (opcionalmente "--read-only") e as variáveis de ambiente abaixo. O servidor aceita as versões 2024-11-05, 2025-03-26, 2025-06-18 e 2025-11-25 do protocolo MCP e implementa initialize, ping, tools/list e tools/call. Os resultados das ferramentas trazem um bloco de texto JSON e também structuredContent.

Teste rápido de stdio bruto (envie por pipe para 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":{}}}

Não há transporte HTTP hospedado para o servidor com escopo de conta. Um endpoint MCP remoto com permissão de escrita exigiria OAuth por usuário, que o SendHQ não oferece; o binário local mantém a chave na máquina que já a possui.

Ambiente e flags

Variável ou flagObrigatórioSignificado
SENDHQ_API_KEYsimChave de API do workspace (re_…). Todas as ferramentas, exceto get_service_health, precisam dela. Sem ela, o servidor ainda inicia e toda chamada retorna um auth_error estruturado explicando como corrigir.
SENDHQ_API_BASE_URLnãoURL base da API. Padrão: https://sendhq.cc/api/v1. Use apenas em um deploy local ou de staging. SENDHQ_BASE_URL é aceita como alias antigo.
SENDHQ_MCP_READ_ONLYnão1, true ou yes se comporta como --read-only.
--read-onlynãoExpõe apenas as ferramentas que não enviam e-mail nem alteram estado. As ferramentas ocultas também são recusadas se chamadas pelo nome.
SENDHQ_PROFILE / --profilenãoUsa uma chave armazenada por sendhq auth login no chaveiro do sistema operacional em vez de SENDHQ_API_KEY. A variável de ambiente prevalece quando ambas existem.

A chave é enviada somente no cabeçalho Authorization: Bearer para a URL base configurada. Ela nunca é impressa, registrada em log, repetida em erros nem incluída nos resultados das ferramentas.

Modelo de segurança para agentes

  • 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.
  • Altera estado. Criar ou atualizar rascunhos, templates, domínios e caixas de entrada, publicar templates e iniciar a verificação alteram o workspace, mas não enviam e-mails.
  • Somente leitura. Todo o resto é readOnlyHint: true e pode ser chamado livremente.
  • O DNS nunca é alterado por este servidor. add_domain retorna registros para uma pessoa publicar; get_domain_connect_link retorna uma URL de consentimento que uma pessoa precisa abrir e aprovar no provedor de DNS.
  • A cobrança nunca é alterada por este servidor. get_account lê apenas o plano, o uso e o estado da assinatura.
  • 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).
  • Não troque o endereço De para contornar uma pausa 423 e nunca adicione de novo destinatários que se descadastraram ou reclamaram.

Chaves de API estão fora do escopo

Por design, não há ferramentas que criem, modifiquem, rotacionem, revoguem ou excluam chaves de API. Um agente não deve emitir nem destruir credenciais. list_api_keys retorna apenas nomes, prefixos não secretos e horários do último uso. O gerenciamento de chaves fica no painel, com uma pessoa autenticada.

Fluxos de trabalho

1. Primeiro envio

  1. get_service_health confirma que a API está acessível (funciona sem chave).
  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 lista os endereços De que você pode usar. Se estiver vazia, faça primeiro o fluxo de domínio.
  4. Confirme remetente, destinatário, assunto e corpo com o usuário e, depois, use send_email com um idempotency_key.
  5. list_email_events com o id retornado mostra delivery, bounce, complaint ou reject assim que o provedor informa (em geral, de segundos a minutos).
Primeiro envio
{
  "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. Verificação de domínio de ponta a ponta

  1. add_domain with name: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).
  2. get_dns_provider com o domain_id detecta o provedor de DNS autoritativo e retorna o host relativo exato a informar para cada registro nesse provedor.
  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. Quando status for verified, os endereços do domínio aparecem em list_sending_identities.

3. Bounces, reclamações e supressões

  1. list_blocked_recipients retorna todos os endereços bloqueados com o motivo (bounce, complaint, unsubscribe) e uma contagem resumida.
  2. list_suppressions retorna as supressões por hard bounce e por reclamação; deliverability_stats traz as taxas de entrega, bounce e reclamação dos últimos 30 dias; list_sender_reputation mostra quais endereços De estão com o ritmo reduzido ou pausados.
  3. Um envio que contém um destinatário suprimido falha com 422 recipient_suppressed. Remova esse destinatário e envie de novo.
  4. Somente quando uma pessoa confirmar que uma caixa postal que deu bounce voltou a funcionar, chame remove_suppression. Supressões por reclamação são permanentes (409 complaint_suppression_locked).

4. Receber e-mails de entrada

  1. O domínio (muitas vezes um subdomínio, como inbound.example.com) precisa estar verificado.
  2. setup_inbound provisiona o recebimento e retorna um registro MX. Uma pessoa o publica.
  3. verify_inbound até que status seja ready.
  4. create_inbox com domain_id e local_part (por exemplo, support) cria support@inbound.example.com.
  5. Consulte list_emails com direction: "in" e unread: true (opcionalmente inbox_id). Leia uma mensagem com get_email, a conversa com get_thread, os anexos com download_attachment e marque-a como tratada com mark_email (read: true).
  6. Responda na mesma thread com send_email e reply_to_email_id; o SendHQ define In-Reply-To, References e a thread.

5. Webhooks e notificações de eventos

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. Diagnosticar uma falha de entrega

  1. Encontre a mensagem: list_emails com direction: "out" e to ou query, ou get_email se você tiver o ID. status: failed significa que o SendHQ ou o provedor a rejeitou na submissão; o erro do e-mail explica o motivo.
  2. list_email_events: bounce (permanente ou transitório, com o diagnóstico do provedor), complaint, reject ou delivery. Nenhum evento ainda significa que o provedor não informou nada; aguarde e verifique de novo.
  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 verifica se DKIM, SPF e DMARC ainda estão publicados; deliverability_stats mostra se o problema é uma única mensagem ou uma tendência.
  5. Relate o que as evidências mostram. Um evento delivery significa que o servidor do destinatário aceitou a mensagem, não que ela chegou à caixa de entrada nem que foi lida.

7. Tenha uma categoria de tarefas (marcadores)

  1. create_label com name (por exemplo, Agent/Orders) e skip_inbox: true. Isso transforma o marcador em uma categoria: os e-mails recebidos que a recebem são arquivados e aparecem apenas no marcador, nunca na Caixa de entrada da pessoa.
  2. Envie e-mails de tarefas com send_email (ou send_batch) e labels: ["Agent/Orders"]. As respostas a essa conversa herdam o marcador automaticamente e não vão para a Caixa de entrada.
  3. Para e-mails que começam fora das suas conversas, adicione uma regra de arquivamento: create_label_rule com inbox_id (um endereço dedicado, como orders@…), from, to ou subject. Passe apply_to_existing: true para arquivar e-mails já recebidos.
  4. Trabalhe a categoria: list_emails com label: "Agent/Orders", direction: "in" e unread: true; leia com get_email ou get_thread, responda com send_email e reply_to_email_id e use mark_email com read: true quando concluir.
  5. Mova uma mensagem avulsa para dentro ou para fora com label_email (add / remove). Adicionar o marcador de uma categoria a uma mensagem recebida também a arquiva.
  6. Opcionalmente, set_inbox_forwarding envia uma cópia de tudo o que um endereço de recebimento recebe para outra caixa postal (o destino confirma antes por e-mail).
Enviar para uma categoria
{
  "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. Anexos e templates

Anexe até 10 arquivos com attachments de send_email (cada um precisa de content_base64 ou de um file_path local; filename assume por padrão o nome-base do arquivo) em um plano pago. Para templates hospedados: create_template → update_template_draft → render_template para pré-visualizar com dados de exemplo → send_template_test (envia um teste real) → publish_template e, depois, envie com send_email ou send_batch usando template: {key, data} e exatamente um destinatário em 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>"
  }
}

Resultados, paginação e erros

Uma chamada bem-sucedida retorna o objeto JSON da API como structuredContent e como bloco de texto JSON. Toda ferramenta list_* aceita limit (1–200, padrão 50) e offset, e adiciona um objeto pagination. Continue chamando com offset: pagination.next_offset enquanto has_more for true.

Resultado paginado
{
  "data": [
    "…"
  ],
  "count": 50,
  "pagination": {
    "offset": 0,
    "limit": 50,
    "returned": 50,
    "total": 180,
    "has_more": true,
    "next_offset": 50
  }
}

Uma chamada com falha retorna isError: true com um erro estruturado. Siga o remedy em vez de tentar novamente às cegas; só tente de novo quando retryable for true.

Erro estruturado de ferramenta
{
  "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."
  }
}

Campos de erro opcionais: request_id (informe-o ao suporte), retry_after_seconds, problems (lista de violações de schema para invalid_arguments) e idempotent_replayed (veja Idempotência).

Idempotência

send_email e send_batch aceitam idempotency_key (máx. 200 caracteres), enviado como o cabeçalho Idempotency-Key. Gere uma chave estável por mensagem lógica, por exemplo invoice-4812-receipt.

  • Uma nova tentativa deve reutilizar a mesma chave E um corpo de requisição idêntico. A mesma chave com qualquer alteração (destinatário, assunto, corpo, cabeçalho, dados do template, até valores de argumentos) retorna 409 idempotency_conflict.
  • Mesma chave, mesmo corpo, original já concluído: o SendHQ retorna o resultado armazenado sem enviar de novo. É assim que você tenta novamente com segurança após um timeout ou network_error.
  • Mesma chave enquanto o original ainda está em execução: 409 idempotency_in_progress, com nova tentativa possível após uma curta espera.
  • Uma nova mensagem lógica exige uma nova chave.
  • Falhas armazenadas também são reproduzidas. Se a primeira tentativa falhou, tentar de novo com a mesma chave retorna essa mesma falha com idempotent_replayed: true e retryable: false. Verifique list_emails (direction: out) para confirmar que nada saiu, corrija a causa e envie com uma nova chave.
  • O servidor nunca repete um POST por conta própria. Apenas chamadas GET somente leitura são repetidas automaticamente (até 3 tentativas em erros de rede, 429 e 5xx).
  • send_email com attachments inline não pode receber um idempotency_key, porque executa várias requisições. Para envios de anexos seguros para novas tentativas: create_draft → upload_attachment → send_email com draft_id e idempotency_key.
Envio seguro para novas tentativas (repita exatamente em caso de timeout)
{
  "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"
  }
}

Limites de taxa e cotas

O SendHQ não publica um limite fixo de requisições por segundo para a API. Os limites que um agente realmente encontra são limites de uso, retornados como 429:

  • Entregas mensais a destinatários por plano. Cada endereço em To, Cc e Bcc conta como uma entrega. Veja get_account → usage.recipientDeliveries vs. usage.emailQuotaMonth.
  • Destinatários diários por endereço De exato, definidos pelo estado de reputação desse remetente (list_sender_reputation → dailyLimit, 2.000 por padrão nos planos pagos).
  • 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.
  • Anexos: no máximo 10 arquivos e 10 MB por mensagem; 10 GB de transferência de anexos ponderada por destinatário por mês nos planos pagos.
  • Por requisição: To + Cc + Bcc até 100 endereços; send_batch até 100 mensagens.
  • Disjuntor de reputação: em uma janela móvel de 7 dias, bounces ou reclamações acima do limite reduzem o ritmo ou pausam um endereço De (423 sender_paused). Ele se recupera automaticamente quando as taxas caem.

quota_exhausted não permite nova tentativa até que o período seja reiniciado ou o plano mude. rate_limited permite nova tentativa após retry_after_seconds; em envios, tente de novo com o mesmo idempotency_key e o corpo idêntico.

Catálogo de erros

code é estável; ramifique por ele e não por message.

codeHTTPRepetir?O que significa e o que fazer
invalid_arguments—nãoOs argumentos falharam no JSON Schema da ferramenta localmente; nada chegou ao SendHQ. Corrija os campos listados em problems.
auth_error401nãoChave de API ausente, revogada ou incorreta. Defina SENDHQ_API_KEY para o processo do servidor; uma pessoa cria as chaves no painel.
subscription_required402nãoNo active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then.
payment_required402nãoO recurso exige um plano pago (por exemplo, anexos). Envie sem ele ou faça upgrade.
sender_domain_not_owned403nãoO domínio De não está neste workspace. Use list_sending_identities ou add_domain.
sender_domain_unverified403nãoO domínio De ainda não foi verificado. get_domain, publique os registros que faltam, verify_domain.
domain_limit_reached403nãoLimite de domínios do plano atingido. Remova um domínio sem uso (com aprovação) ou faça upgrade.
marketing_not_enabled403nãoA classe de marketing não está habilitada para este domínio ou plano. Use transactional somente se a mensagem realmente for transacional.
forbidden403nãoA política não permite a operação. Ajuste a requisição.
not_found404nãoO ID não está neste workspace. Liste o recurso para encontrar o ID correto; restaure antes os templates arquivados.
idempotency_conflict409nãoChave reutilizada com um corpo diferente. Reenvie exatamente o original ou use uma nova chave para uma nova mensagem.
idempotency_in_progress409simA requisição original ainda está em execução. Aguarde e tente de novo com a mesma chave e o mesmo corpo.
revision_conflict409nãoO rascunho do template mudou desde que você o leu. get_template, faça o merge e salve de novo.
complaint_suppression_locked409nãoO destinatário reclamou. Nunca mais envie e-mail para ele.
inbound_not_ready409nãoO recebimento de e-mails de entrada não está pronto. setup_inbound, publique o MX, verify_inbound.
conflict409nãoO recurso já existe ou está no estado errado. Leia-o e ajuste.
attachments_too_large413nãoMais de 10 arquivos ou 10 MB. Remova ou reduza os anexos.
recipient_suppressed422nãoUm destinatário teve hard bounce ou reclamou antes. Remova-o; veja list_blocked_recipients.
recipient_unsubscribed422nãoUm destinatário optou por não receber e-mails de marketing. Remova-o permanentemente.
validation_failed422nãoConteúdo rejeitado, por exemplo dados de template que quebram o contrato de variáveis. Corrija a entrada.
sender_paused423nãoEste endereço De está pausado pelo disjuntor de bounces/reclamações de 7 dias. Pare, corrija a lista e aguarde a recuperação automática.
account_paused423nãoWorkspace 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_exhausted429nãoMonthly 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_limited429simSlow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap.
server_error5xxsimFalha temporária do SendHQ ou do provedor. Use backoff e tente de novo; em envios, com a mesma chave e o mesmo corpo. Se idempotent_replayed for true, use uma nova chave depois de confirmar que nada foi enviado.
network_error—simRequisição ou resposta perdida. Tente de novo; em envios, o mesmo idempotency_key torna isso seguro.
invalid_request400nãoRequisição malformada. Leia message e corrija.
tool_error—nãoFalha local dentro do servidor MCP (por exemplo, um file_path ilegível). Leia message.

Referência das ferramentas

Todas as ferramentas com sua classe de segurança, o endpoint REST que chamam, os parâmetros, o formato de retorno e um exemplo de objeto de params de tools/call. Os parâmetros são exatos: o servidor rejeita qualquer coisa que não esteja listada.

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

E-mails e threads

Envia e-mail realsend_email
POST /emails

Enviar um e-mail

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.

Informe pelo menos um destes: html, text, template.

ParâmetroTipoObrigatórioDescrição
fromstringsimRemetente, por exemplo Acme <hello@example.com>. O domínio precisa estar verificado neste workspace (veja list_sending_identities). (máx. 998 caracteres)
tostring[]simDestinatários. Cada entrada é um endereço, opcionalmente com nome de exibição. To+cc+bcc podem somar no máximo 100; cada destino consome um crédito de entrega. (1–100 itens)
ccstring[]nãoDestinatários em cópia. (0–100 itens)
bccstring[]nãoDestinatários em cópia oculta. (0–100 itens)
subjectstringnãoLinha de assunto. Omita ao enviar um template. (máx. 998 caracteres)
textstringnãoCorpo em texto simples. Informe text, html ou template.
htmlstringnãoCorpo em HTML. O SendHQ o sanitiza e gera o texto quando text é omitido.
reply_tostringnãoEndereço de Reply-To.
headersobjectnãoCabeçalhos personalizados seguros extras (valores em string), por exemplo {"X-Entity-Ref-ID": "123"}. Cabeçalhos de roteamento como From/To/Message-ID são controlados pelo SendHQ.
message_classstringnãotransactional (padrão) ou marketing. Marketing exige um plano ou domínio com marketing habilitado e adiciona o tratamento de descadastro. (um de transactional, marketing)
reply_to_email_idstringnãoResponde dentro de uma conversa existente: o ID em_… da mensagem que está sendo respondida. O SendHQ define In-Reply-To/References e a thread.
thread_idstringnãoID explícito da thread em que a mensagem será arquivada.
draft_idstringnãoEnvia os anexos de um rascunho armazenado com esta mensagem (dr_…). O rascunho é excluído após um envio bem-sucedido.
templateobjectnãoEnvia um template hospedado publicado em vez de html/texto bruto. Exige exatamente um destinatário em to e nenhum cc/bcc; o template fornece o assunto. Informe pelo menos um destes: id, key.
template.idstringnãoID do template (tmpl_…). Informe id ou key.
template.keystringnãoChave do template, como account-welcome. Informe id ou key.
template.version_idstringnãoID de release publicada opcional (tmplv_…). Por padrão, é a release publicada atual.
template.dataobjectnãoValores das variáveis tipadas do template.
labelsstring[]nãoNomes de marcadores ou IDs lbl_… em que esta mensagem será arquivada. Nomes desconhecidos são criados. As respostas na conversa herdam os marcadores, e um marcador de categoria (skip_inbox) mantém essas respostas fora da Caixa de entrada. Máx. 10. (0–10 itens)
idempotency_keystringnãoCabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres)
attachmentsobject[]nãoArquivos a anexar (máx. 10 arquivos, 10 MB no total). Cada um precisa de content_base64 (mais filename) ou de um file_path local. (0–10 itens) Informe pelo menos um destes: content_base64, file_path.
attachments[].filenamestringnãoNome do arquivo exibido ao destinatário. Obrigatório com content_base64; por padrão, é o nome-base de file_path. (máx. 255 caracteres)
attachments[].content_typestringnãoTipo MIME, por exemplo application/pdf. O padrão é application/octet-stream.
attachments[].content_base64stringnãoConteúdo do arquivo em base64 padrão.
attachments[].file_pathstringnãoCaminho absoluto de um arquivo local legível pelo processo do servidor MCP.
Retorno{id: em_…, providerMessageId, threadId, templateId, templateVersionId, isTest}. Aceito não é entregue: acompanhe com list_email_events.
Exemplo de params de 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"
  }
}
Envia e-mail realsend_batch
POST /emails/batch

Enviar um lote de e-mails individualizados

ENVIA E-MAIL REAL. Envia de 1 a 100 mensagens independentes em uma única requisição (use para personalização de template por destinatário). Cada item tem o mesmo formato de send_email (sem attachments/idempotency_key). Os itens têm sucesso ou falha individualmente: HTTP 207 significa sucesso parcial; inspecione data[i].ok e data[i].error de cada um. Um único idempotency_key cobre todo o corpo do lote.

ParâmetroTipoObrigatórioDescrição
emailsobject[]simMensagens a enviar. (1–100 itens) Informe pelo menos um destes: html, text, template.
idempotency_keystringnãoIdempotency-Key para todo o lote (máx. 200 caracteres). (máx. 200 caracteres)
Retorno{data: [{index, ok, id?, error?: {message, status}}], count, successful, failed}.
Exemplo de params de 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"
  }
}
Somente leituralist_emails
GET /emails

Listar e pesquisar e-mails

Lista e-mails enviados (direction: out) e recebidos (direction: in) do mais novo para o mais antigo, com filtros. Os e-mails recebidos são classificados: leia a caixa de entrada da pessoa com direction: in, archived: false, category: primary; faça a triagem com important: true; o spam fica oculto, a menos que category: spam ou include_spam: true. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
directionstringnãoin para recebidos, out para enviados. (um de in, out)
statusstringnãoFiltro de status, por exemplo queued, sent, delivered, bounced, complained, failed.
domainstringnãoApenas mensagens deste domínio, ou de uma lista de domínios separados por vírgula (corresponde a qualquer um).
inbox_idstringnãoApenas mensagens recebidas por esta caixa de entrada (inb_…).
labelstringnãoApenas mensagens com este marcador: um ID de marcador lbl_… ou o nome exato, ou uma lista separada por vírgula (corresponde a qualquer um). Use list_labels para ver as pastas.
archivedbooleannãofalse = a visualização da Caixa de entrada (e-mails recebidos não arquivados), true = apenas arquivados. Omita para todos os e-mails.
categorystringnãoprimary (pessoas), updates (newsletters, envios em massa, automáticos) ou spam; ou uma lista separada por vírgula. O spam fica oculto, a menos que solicitado.
importantbooleannãotrue = apenas mensagens marcadas como importantes (respostas a conversas que você iniciou e remetentes marcados como importantes).
include_spambooleannãoInclui spam nos resultados (para pesquisas em todas as pastas).
fromstringnãoO endereço do remetente contém este valor.
tostringnãoO endereço do destinatário contém este valor.
unreadbooleannãotrue = apenas não lidas, false = apenas lidas.
afterstringnãoTimestamp ISO-8601; apenas mensagens criadas depois dele. (date-time)
beforestringnãoTimestamp ISO-8601; apenas mensagens criadas antes dele. (date-time)
querystringnãoPesquisa de texto livre em assuntos, corpos, endereços de remetente/destinatário e nomes de arquivos de anexos. (máx. 200 caracteres)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [resumos de e-mails], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_emails",
  "arguments": {
    "direction": "in",
    "unread": true,
    "limit": 25
  }
}
Somente leituraget_email
GET /emails/:email_id

Obter um e-mail

Recupera uma mensagem com cabeçalhos, corpo html/texto, status, metadados da thread e metadados dos anexos (baixe os bytes com download_attachment).

ParâmetroTipoObrigatórioDescrição
email_idstringsimID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
RetornoObjeto de e-mail: {id, direction, status, from, to, cc, bcc, subject, html, text, threadId, messageId, providerMessageId, readAt, createdAt, attachments: [{id, filename, contentType, sizeBytes, available}]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Altera estadomark_email
PATCH /emails/:email_id

Marcar como lido, arquivado, spam ou importante

Atualiza uma mensagem: read, archived, category (primary, updates, spam; apenas e-mails recebidos) e important. Denunciar spam ou marcar como importante ensina o SendHQ sobre esse remetente para os próximos e-mails; passe learn: false para alterar apenas esta mensagem. Informe pelo menos um campo.

ParâmetroTipoObrigatórioDescrição
email_idstringsimID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
readbooleannãotrue = lida, false = não lida.
archivedbooleannãotrue = arquivar (não vai para a Caixa de entrada), false = mover de volta para a Caixa de entrada.
categorystringnãoMove uma mensagem recebida para primary, updates ou spam. (um de primary, updates, spam)
importantbooleannãoMarca ou desmarca a mensagem como importante.
learnbooleannãofalse = não memorizar este veredito para o remetente (padrão true).
RetornoO objeto de e-mail atualizado.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "mark_email",
  "arguments": {
    "email_id": "em_123",
    "read": true
  }
}
Destrutivadelete_email
DELETE /emails/:email_id

Excluir um e-mail

DESTRUTIVA: exclui permanentemente do SendHQ uma mensagem retida e seus anexos armazenados. Não recolhe uma mensagem que já foi entregue.

ParâmetroTipoObrigatórioDescrição
email_idstringsimID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Somente leituralist_email_events
GET /emails/:email_id/events

Listar eventos de entrega de um e-mail

Eventos do provedor para uma mensagem enviada: delivery, bounce, complaint, reject, open, click. Esta é a evidência de que uma mensagem foi entregue ou do motivo da falha. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
email_idstringsimID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{event_type, recipient, reason, created_at, …}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_email_events",
  "arguments": {
    "email_id": "em_123"
  }
}
Somente leituraget_thread
GET /threads/:thread_id

Obter uma conversa

Recupera todas as mensagens de uma conversa em ordem cronológica (enviadas e recebidas), cada uma com os metadados dos anexos.

ParâmetroTipoObrigatórioDescrição
thread_idstringsimID da thread (em geral, o ID em_… da primeira mensagem; veja threadId em qualquer e-mail). (máx. 128 caracteres)
Retorno{id, subject, data: [e-mails]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
email_idstringsim
limitintegernão
offsetintegernão
Returns{emailId, status, timeline, count, limit, offset}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
thread_idstringsim
Returns{threadId, delivered, bounced, complained, failed, messages}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "thread_delivery",
  "arguments": {
    "thread_id": "thr_123"
  }
}

Marcadores e regras de arquivamento automático

Somente leituralist_labels
GET /labels

Listar marcadores

Lista os marcadores (pastas) do workspace com as contagens total e de não lidos e suas regras de arquivamento automático. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{id, name, color, totalCount, unreadCount, rules: [...]}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_labels",
  "arguments": {}
}
Somente leituraget_label
GET /labels/:label_id

Obter um marcador

Recupera um marcador com contagens e regras de arquivamento automático.

ParâmetroTipoObrigatórioDescrição
label_idstringsimID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres)
RetornoObjeto de marcador.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_label",
  "arguments": {
    "label_id": "Billing"
  }
}
Altera estadocreate_label
POST /labels

Criar um marcador

Cria um marcador no estilo de pasta. Defina skip_inbox: true para transformá-lo em uma categoria que pertence a um agente: envie com labels: [name] e as respostas são arquivadas no marcador e mantidas fora da Caixa de entrada. Regras opcionais de arquivamento automático arquivam e-mails novos enviados/recebidos (todas as condições de uma regra precisam corresponder). Defina apply_to_existing para arquivar também os e-mails retidos.

ParâmetroTipoObrigatórioDescrição
namestringsimNome do marcador, por exemplo Billing ou Clients/Acme. Único por workspace (sem diferenciar maiúsculas de minúsculas). (máx. 64 caracteres)
colorstringnãoCor hexadecimal, como #1a73e8. Opcional.
skip_inboxbooleannãoModo categoria: os e-mails recebidos que recebem este marcador (por regra, por resposta a uma conversa enviada com este marcador ou manualmente) são arquivados e aparecem apenas no marcador, não na Caixa de entrada.
rulesobject[]nãoRegras opcionais de arquivamento automático (máx. 20). Cada uma precisa de pelo menos um entre inbox_id, from, to, subject. (0–20 itens)
rules[].directionstringnãoApenas e-mails in (recebidos) ou out (enviados). Omita para ambos. (um de in, out)
rules[].inbox_idstringnãoApenas e-mails recebidos por esta caixa de entrada (inb_…). Arquiva cada endereço de recebimento em sua própria pasta.
rules[].fromstringnãoO remetente contém este texto (sem diferenciar maiúsculas de minúsculas), por exemplo @stripe.com. (máx. 200 caracteres)
rules[].tostringnãoTo/Cc contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres)
rules[].subjectstringnãoO assunto contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres)
rules[].skip_inboxbooleannãoArquiva os e-mails recebidos correspondentes para que apareçam apenas na pasta do marcador, não na Caixa de entrada.
apply_to_existingbooleannãoArquiva também os e-mails já retidos que correspondem às regras.
RetornoO marcador criado, com as regras.
Exemplo de params de tools/call
{
  "name": "create_label",
  "arguments": {
    "name": "Agent/Orders",
    "skip_inbox": true,
    "rules": [
      {
        "from": "@stripe.com"
      }
    ]
  }
}
Altera estadoupdate_label
PATCH /labels/:label_id

Renomear, mudar a cor ou transformar um marcador em categoria

Renomeia um marcador, muda sua cor ou alterna o modo categoria (skip_inbox). Ativar o modo categoria arquiva os e-mails recebidos que já estão no marcador.

ParâmetroTipoObrigatórioDescrição
label_idstringsimID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres)
namestringnãoNovo nome. (máx. 64 caracteres)
colorstringnãoNova cor hexadecimal.
skip_inboxbooleannãoModo categoria: os e-mails recebidos que recebem este marcador (por regra, por resposta a uma conversa enviada com este marcador ou manualmente) são arquivados e aparecem apenas no marcador, não na Caixa de entrada.
RetornoMarcador atualizado.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "update_label",
  "arguments": {
    "label_id": "lbl_123",
    "name": "Finance/Billing"
  }
}
Destrutivadelete_label
DELETE /labels/:label_id

Excluir um marcador

DESTRUTIVA: exclui um marcador e suas regras. O e-mail em si é mantido; ele apenas perde este marcador.

ParâmetroTipoObrigatórioDescrição
label_idstringsimID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_label",
  "arguments": {
    "label_id": "lbl_123"
  }
}
Altera estadocreate_label_rule
POST /labels/:label_id/rules

Adicionar uma regra de arquivamento automático

Adiciona uma regra a um marcador para que os novos e-mails correspondentes sejam arquivados automaticamente. Todas as condições definidas precisam corresponder. Use inbox_id para dar a um endereço de recebimento a própria pasta; adicione skip_inbox para mantê-lo fora da Caixa de entrada.

ParâmetroTipoObrigatórioDescrição
label_idstringsimID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres)
directionstringnãoApenas e-mails in (recebidos) ou out (enviados). Omita para ambos. (um de in, out)
inbox_idstringnãoApenas e-mails recebidos por esta caixa de entrada (inb_…). Arquiva cada endereço de recebimento em sua própria pasta.
fromstringnãoO remetente contém este texto (sem diferenciar maiúsculas de minúsculas), por exemplo @stripe.com. (máx. 200 caracteres)
tostringnãoTo/Cc contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres)
subjectstringnãoO assunto contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres)
skip_inboxbooleannãoArquiva os e-mails recebidos correspondentes para que apareçam apenas na pasta do marcador, não na Caixa de entrada.
apply_to_existingbooleannãoArquiva também os e-mails já retidos que correspondem.
Retorno{id: lrule_…, labelId, direction, inboxId, from, to, subject, skipInbox}.
Exemplo de params de tools/call
{
  "name": "create_label_rule",
  "arguments": {
    "label_id": "Billing",
    "inbox_id": "inb_123",
    "skip_inbox": true
  }
}
Destrutivadelete_label_rule
DELETE /labels/:label_id/rules/:rule_id

Excluir uma regra de arquivamento automático

DESTRUTIVA: remove uma regra de arquivamento automático. Os e-mails já arquivados mantêm o marcador.

ParâmetroTipoObrigatórioDescrição
label_idstringsimID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres)
rule_idstringsimID da regra (começa com lrule_), obtido em get_label. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_label_rule",
  "arguments": {
    "label_id": "lbl_123",
    "rule_id": "lrule_123"
  }
}
Altera estadolabel_email
POST /emails/:email_id/labels

Adicionar ou remover marcadores de um e-mail

Move uma mensagem entre pastas: adiciona e/ou remove marcadores por nome ou por ID lbl_…. Nomes desconhecidos em add são criados, a menos que create seja false.

ParâmetroTipoObrigatórioDescrição
email_idstringsimID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
addstring[]nãoMarcadores a adicionar. (0–10 itens)
removestring[]nãoMarcadores a remover. (0–10 itens)
createbooleannãoCria os marcadores desconhecidos em add (padrão true).
RetornoO e-mail atualizado com labels.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "label_email",
  "arguments": {
    "email_id": "em_123",
    "add": [
      "Billing"
    ],
    "remove": [
      "Support"
    ]
  }
}

Rascunhos, anexos e identidades de remetente

Somente leituralist_sending_identities
GET /sending-identities

Listar identidades de remetente verificadas

Endereços e domínios a partir dos quais este workspace pode enviar agora (domínios verificados, seu De padrão e endereços de caixas de entrada ativas). Chame antes de send_email para escolher um from válido.

Sem parâmetros.

Retorno{domains: [nomes de domínios verificados], addresses: [endereços de remetente], localParts: [...]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_sending_identities",
  "arguments": {}
}
Altera estadocreate_draft
POST /drafts

Criar um rascunho

Cria um rascunho do compositor. Os rascunhos guardam anexos: crie um rascunho, use upload_attachment e depois send_email com draft_id. Não envia nada.

ParâmetroTipoObrigatórioDescrição
fromstringnãoEndereço de remetente em um domínio verificado (pode ficar vazio durante a edição).
tostring[]nãoDestinatários. (0–100 itens)
ccstring[]nãoDestinatários em cópia. (0–100 itens)
bccstring[]nãoDestinatários em cópia oculta. (0–100 itens)
subjectstringnãoLinha de assunto. (máx. 998 caracteres)
htmlstringnãoCorpo em HTML.
textstringnãoCorpo em texto simples.
reply_to_email_idstringnãoID do e-mail ao qual este rascunho responde.
thread_idstringnãoID da thread à qual este rascunho pertence.
RetornoObjeto de rascunho {id: dr_…, from, to, cc, bcc, subject, html, text, attachments: []}.
Exemplo de params de tools/call
{
  "name": "create_draft",
  "arguments": {
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice"
  }
}
Somente leituralist_drafts
GET /drafts

Listar rascunhos

Lista os rascunhos do compositor, do atualizado mais recentemente para o mais antigo. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [rascunhos], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_drafts",
  "arguments": {}
}
Somente leituraget_draft
GET /drafts/:draft_id

Obter um rascunho

Recupera um rascunho com os metadados dos anexos.

ParâmetroTipoObrigatórioDescrição
draft_idstringsimID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
RetornoObjeto de rascunho com attachments.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Altera estadoupdate_draft
PUT /drafts/:draft_id

Substituir o conteúdo do rascunho

Substitui o conteúdo e os destinatários de um rascunho. É uma substituição completa: os campos omitidos são apagados; portanto, leia get_draft primeiro e envie todos os campos que quiser manter. Os anexos não são afetados.

ParâmetroTipoObrigatórioDescrição
draft_idstringsimID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
fromstringnãoEndereço de remetente em um domínio verificado (pode ficar vazio durante a edição).
tostring[]nãoDestinatários. (0–100 itens)
ccstring[]nãoDestinatários em cópia. (0–100 itens)
bccstring[]nãoDestinatários em cópia oculta. (0–100 itens)
subjectstringnãoLinha de assunto. (máx. 998 caracteres)
htmlstringnãoCorpo em HTML.
textstringnãoCorpo em texto simples.
reply_to_email_idstringnãoID do e-mail ao qual este rascunho responde.
thread_idstringnãoID da thread à qual este rascunho pertence.
RetornoObjeto de rascunho atualizado.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "update_draft",
  "arguments": {
    "draft_id": "dr_123",
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice (updated)",
    "text": "Attached."
  }
}
Destrutivadelete_draft
DELETE /drafts/:draft_id

Descartar um rascunho

DESTRUTIVA: descarta um rascunho e exclui permanentemente seus anexos armazenados.

ParâmetroTipoObrigatórioDescrição
draft_idstringsimID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Altera estadoupload_attachment
POST /drafts/:draft_id/attachments

Fazer upload de um anexo para um rascunho

Faz o upload de um arquivo para um rascunho (máx. 10 arquivos e 10 MB no total por mensagem). Informe content_base64 ou um file_path local. Os anexos exigem um plano pago no momento do envio.

Informe pelo menos um destes: content_base64, file_path.

ParâmetroTipoObrigatórioDescrição
draft_idstringsimID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
filenamestringnãoNome do arquivo exibido ao destinatário. Por padrão, é o nome-base de file_path. (máx. 255 caracteres)
content_typestringnãoTipo MIME, por exemplo application/pdf. O padrão é application/octet-stream.
content_base64stringnãoConteúdo do arquivo em base64 padrão.
file_pathstringnãoCaminho absoluto de um arquivo local legível pelo processo do servidor MCP.
Retorno{id: att_…, filename, contentType, sizeBytes, available}.
Exemplo de params de tools/call
{
  "name": "upload_attachment",
  "arguments": {
    "draft_id": "dr_123",
    "filename": "invoice.pdf",
    "content_type": "application/pdf",
    "file_path": "/tmp/invoice.pdf"
  }
}
Somente leituradownload_attachment
GET /attachments/:attachment_id

Baixar um anexo

Baixa um anexo privado (enviado, recebido ou de rascunho). Retorna o conteúdo em base64 ou grava o arquivo quando save_to_path é definido (recusa sobrescrever, a menos que overwrite seja true).

ParâmetroTipoObrigatórioDescrição
attachment_idstringsimID do anexo (começa com att_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
save_to_pathstringnãoCaminho local absoluto opcional para gravar o arquivo em vez de retornar base64.
overwritebooleannãoPermite substituir um arquivo existente em save_to_path. O padrão é false.
Retorno{attachment_id, filename, content_type, size_bytes, content_base64} ou {attachment_id, filename, content_type, size_bytes, saved_to}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "download_attachment",
  "arguments": {
    "attachment_id": "att_123",
    "save_to_path": "/tmp/invoice.pdf"
  }
}
Destrutivadelete_attachment
DELETE /attachments/:attachment_id

Excluir um anexo

DESTRUTIVA: exclui permanentemente um anexo armazenado (por exemplo, para remover um arquivo de um rascunho antes de enviar).

ParâmetroTipoObrigatórioDescrição
attachment_idstringsimID do anexo (começa com att_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_attachment",
  "arguments": {
    "attachment_id": "att_123"
  }
}

Templates hospedados

Somente leituralist_templates
GET /templates

Listar templates hospedados

Lista os templates de e-mail hospedados com estado de publicação e uso. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
lifecyclestringnãoactive (padrão), archived ou all. (um de active, archived, all)
querystringnãoPesquisa por nome ou chave. (máx. 120 caracteres)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [templates], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_templates",
  "arguments": {
    "lifecycle": "active"
  }
}
Altera estadocreate_template
POST /templates

Criar um template hospedado

Cria um template com um rascunho editável, opcionalmente a partir de um modelo inicial (welcome, reset, receipt ou blank). Publique-o antes de enviar por chave.

ParâmetroTipoObrigatórioDescrição
namestringsimNome legível. (máx. 120 caracteres)
keystringnãoChave de envio estável: letras minúsculas, números e hifens; começa com uma letra (2–64 caracteres). Derivada do nome quando omitida.
starterstringnãoConteúdo inicial. (um de blank, welcome, reset, receipt)
Retorno{template, draft, activeVersion, versions, usage}.
Exemplo de params de tools/call
{
  "name": "create_template",
  "arguments": {
    "name": "Account welcome",
    "key": "account-welcome",
    "starter": "welcome"
  }
}
Somente leituraget_template
GET /templates/:template_id

Obter um template

Recupera o rascunho atual de um template (com revision), a release publicada ativa, o histórico de releases e o uso. Aceita ID ou chave.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID do template (tmpl_…) ou chave. (máx. 128 caracteres)
Retorno{template, draft: {id, revision, subjectTemplate, htmlTemplate, textTemplate, variables, sampleData, …} | null, activeVersion, versions, usage}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Altera estadoupdate_template_draft
PUT /templates/:template_id/draft

Salvar um rascunho de template

Salva o rascunho editável do template usando concorrência otimista: passe o revision atual obtido em get_template (409 significa que outra pessoa salvou primeiro; leia de novo e tente novamente). É uma substituição completa do conteúdo do rascunho: os campos omitidos são apagados; portanto, envie todos os campos que quiser manter. Use placeholders {{variable}}.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
revisionintegersimRevisão atual do rascunho, obtida em get_template. (1–…)
namestringnãoNome do template. (máx. 120 caracteres)
subject_templatestringnãoAssunto com placeholders. (máx. 998 caracteres)
preheader_templatestringnãoTexto de pré-visualização. (máx. 240 caracteres)
html_templatestringnãoCorpo em HTML com placeholders.
text_templatestringnãoCorpo em texto simples com placeholders.
fromstringnãoRemetente padrão para os envios deste template.
reply_tostringnãoReply-To padrão.
variablesobject[]nãoContrato de variáveis tipadas. Cada item: {key (minúsculas/sublinhados), label, type: text|number|url|boolean, required (padrão true), fallback, description}.
variables[].keystringsim
variables[].labelstringnão
variables[].typestringnão(um de text, number, url, boolean)
variables[].requiredbooleannão
variables[].fallbackanynão
variables[].descriptionstringnão
sample_dataobjectnãoValores de exemplo usados em pré-visualizações e testes.
Retorno{template, draft: {revision: next}, validation: {valid, findings}}.
Exemplo de params de 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"
    }
  }
}
Altera estadocreate_template_draft
POST /templates/:template_id/draft

Iniciar um novo rascunho a partir da release publicada

Cria um novo rascunho editável copiado da release publicada atual (409 se já existir um rascunho ou se nada estiver publicado).

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
Retorno{draft}.
Exemplo de params de tools/call
{
  "name": "create_template_draft",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Somente leiturarender_template
POST /templates/:template_id/render

Renderizar uma pré-visualização de template

Renderiza a saída exata do servidor (subject, html, text) para o rascunho, a release publicada ou uma versão específica com os dados informados. Não envia. Retorna 422 com findings quando os dados violam o contrato de variáveis.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
version_idstringnãoID de versão opcional; por padrão, usa o rascunho e, depois, a release publicada.
dataobjectnãoValores das variáveis; por padrão, os dados de exemplo da versão.
Retorno{subject, html, text, preheader, versionId, versionNumber, isDraft, findings}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "render_template",
  "arguments": {
    "template_id": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}
Envia e-mail realsend_template_test
POST /templates/:template_id/test

Enviar um e-mail de teste de template

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.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
tostring[]simDestinatários do teste. (1–100 itens)
fromstringnãoRemetente em um domínio verificado; por padrão, o De do template.
version_idstringnãoID de versão opcional.
dataobjectnãoValores das variáveis; por padrão, os dados de exemplo.
Retorno{id: em_…, providerMessageId, threadId, isTest: true}.
Exemplo de params de tools/call
{
  "name": "send_template_test",
  "arguments": {
    "template_id": "account-welcome",
    "to": [
      "owner@example.com"
    ]
  }
}
Altera estadopublish_template
POST /templates/:template_id/publish

Publicar uma release de template

Publica o rascunho atual como uma release imutável que send_email com template.key usará. Falha com 422 e findings em caso de erros de validação, ou com 409 se quebrasse o contrato de variáveis ativo de um template já usado em produção.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
Retorno{template, published}.
Exemplo de params de tools/call
{
  "name": "publish_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Altera estadoarchive_template
POST /templates/:template_id/archive

Arquivar um template

Interrompe novos envios que usam este template (o histórico é mantido; reversível com restore_template). Qualquer integração que envie com esta chave passará a falhar com 404.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
Retorno{template}.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "archive_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Altera estadorestore_template
POST /templates/:template_id/restore

Restaurar um template arquivado

Torna um template arquivado ativo de novo.

ParâmetroTipoObrigatórioDescrição
template_idstringsimID ou chave do template. (máx. 128 caracteres)
Retorno{template}.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "restore_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}

Domínios e DNS

Somente leituralist_domains
GET /domains

Listar domínios

Lista os domínios de envio com setup_status agregado (verified | checking | pending), estado do DNS por registro e status de entrada. Pode ser lento: domínios não verificados são verificados de novo em tempo real. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [domínios com registros], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_domains",
  "arguments": {}
}
Somente leituraget_domain
GET /domains/:domain_id

Obter os detalhes de configuração de um domínio

Recupera um domínio com os registros DNS exatos a publicar (type, name, value), o estado em tempo real de cada registro em dois resolvedores públicos, dns_issues com correções e o status de entrada.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{id, name, status, setup_status, dns_propagating, records: [{type, name, value, verified, dns_state}], dns_issues: [{code, message, …}], inbound_domain, inbound_status}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Altera estadoadd_domain
POST /domains

Adicionar um domínio de envio

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.

ParâmetroTipoObrigatórioDescrição
namestringsimNome de domínio simples, por exemplo example.com ou mail.example.com. (máx. 253 caracteres)
default_fromstringnãoEndereço de remetente padrão opcional neste domínio.
Retorno{id: dom_…, name, status: pending, records: [...], ses: {configured}}.
Exemplo de params de tools/call
{
  "name": "add_domain",
  "arguments": {
    "name": "example.com"
  }
}
Altera estadoverify_domain
POST /domains/:domain_id/verify

Verificar um domínio

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.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{domain, checks: {ses, dkim, dkim_status}, status: verified|pending}.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "verify_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Destrutivadelete_domain
DELETE /domains/:domain_id

Excluir um domínio

DESTRUTIVA: remove o domínio do workspace, inclusive sua rota de recebimento de entrada. Os envios a partir dele passam a falhar imediatamente. Não exclui registros DNS no seu provedor de DNS.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Somente leituraget_dns_provider
GET /dns/provider

Detectar o provedor de DNS e os hosts dos registros

Detecta o provedor de DNS autoritativo do domínio e retorna o host relativo a digitar nesse provedor para cada registro, o registro DMARC recomendado, orientações de MX de entrada e se a configuração com um clique (Domain Connect) está disponível.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{detectionStatus, detected, zone, nameservers, recordHosts: {recordId: host}, inbound, recommendations, authentication, providers: {domainConnect: {available, providerName}}}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_dns_provider",
  "arguments": {
    "domain_id": "dom_123"
  }
}

E-mail de entrada

Altera estadosetup_inbound
POST /domains/:domain_id/inbound/setup

Habilitar o recebimento de e-mails de entrada em um domínio

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.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{domain: domínio de recebimento, status: dns_pending|ready, record: {type: MX, name, value}}.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "setup_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Altera estadoverify_inbound
POST /domains/:domain_id/inbound/verify

Verificar o MX de entrada

Verifica de novo o registro MX de entrada. O status passa a ready quando os dois resolvedores públicos o enxergam.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{domain, status: ready|dns_pending|propagating|checking, record}.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "verify_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Somente leituralist_inboxes
GET /inboxes

Listar endereços de entrada

Lista os endereços de recebimento, opcionalmente de um domínio. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
domain_idstringnãoFiltro opcional por ID de domínio.
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{id, address, name, status, domainId}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_inboxes",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Somente leituraget_inbox
GET /inboxes/:inbox_id

Obter uma caixa de entrada

Recupera um endereço de entrada.

ParâmetroTipoObrigatórioDescrição
inbox_idstringsimID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
RetornoObjeto de caixa de entrada.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}
Altera estadocreate_inbox
POST /inboxes

Criar um endereço de entrada

Cria um endereço como support@<receiving domain> em um domínio cujo status de entrada seja ready (execute antes setup_inbound e verify_inbound). Os e-mails recebidos aparecem em list_emails com direction in.

ParâmetroTipoObrigatórioDescrição
domain_idstringsimID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
local_partstringsimParte antes do @, por exemplo support. (máx. 64 caracteres)
namestringnãoNome de exibição opcional.
Retorno{id: inb_…, address, name, status: active}.
Exemplo de params de tools/call
{
  "name": "create_inbox",
  "arguments": {
    "domain_id": "dom_123",
    "local_part": "support",
    "name": "Support"
  }
}
Altera estadoupdate_inbox
PATCH /inboxes/:inbox_id

Renomear, ativar ou desativar uma caixa de entrada

Renomeia uma caixa de entrada ou define seu status como active / disabled.

ParâmetroTipoObrigatórioDescrição
inbox_idstringsimID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
namestringnãoNovo nome de exibição.
statusstringnãoNovo status. (um de active, disabled)
RetornoCaixa de entrada atualizada.
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "update_inbox",
  "arguments": {
    "inbox_id": "inb_123",
    "status": "disabled"
  }
}
Envia e-mail realset_inbox_forwarding
PUT /inboxes/:inbox_id/forwarding

Encaminhar uma caixa de entrada para outro endereço

ENVIA E-MAIL REAL ao encaminhar para alguém que não seja o dono da conta: define para onde os e-mails recebidos de uma caixa de entrada são encaminhados. O endereço do próprio dono é ativado imediatamente; qualquer outro endereço recebe um e-mail de confirmação e o encaminhamento permanece pending até que alguém de lá confirme. Passe forward_to: null para desativar o encaminhamento. As cópias encaminhadas vêm do endereço da caixa de entrada, com o remetente original como Reply-To.

ParâmetroTipoObrigatórioDescrição
inbox_idstringsimID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
forward_tostring,nullsimEndereço de e-mail de destino do encaminhamento, ou null para desativá-lo. (máx. 254 caracteres)
RetornoCaixa de entrada com forwardTo e forwardStatus (off, pending ou active).
AnotaçõesidempotentHint
Exemplo de params de tools/call
{
  "name": "set_inbox_forwarding",
  "arguments": {
    "inbox_id": "inb_123",
    "forward_to": "team@example.net"
  }
}
Destrutivadelete_inbox
DELETE /inboxes/:inbox_id

Excluir uma caixa de entrada

DESTRUTIVA: exclui um endereço de entrada. Os e-mails já recebidos são retidos; os novos e-mails para o endereço deixam de ser arquivados nele.

ParâmetroTipoObrigatórioDescrição
inbox_idstringsimID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}

Entregabilidade, bounces e supressões

Somente leituradeliverability_stats
GET /deliverability/stats

Obter estatísticas de entrega dos últimos 30 dias

Totais de 30 dias de todo o workspace: sent, delivery, bounce, complaint, reject, open, click e deliveryRate (%).

Sem parâmetros.

Retorno{window: 30d, sent, delivery, bounce, complaint, reject, open, click, deliveryRate}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
daysintegernão(one of 7, 30, 90)
Returns{days, trend, rolling7d, thresholds, ladder}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
daysintegernão
domainstringnão
limitintegernão
offsetintegernão
Returns{days, data, count, limit, offset}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
daysintegernão
domainstringnão
limitintegernão
offsetintegernão
Returns{days, data, count, limit, offset}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
subjectstringnãoThe subject line.
htmlstringnãoThe HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars)
textstringnãoThe plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars)
fromstringnãoThe 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}]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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>"
  }
}
Somente leituralist_sender_reputation
GET /deliverability/reputation

Listar a reputação do remetente

Estado de reputação por endereço De exato: active, throttled (limite diário menor) ou paused (os envios retornam 423), com o motivo e o limite diário. Verifique isto quando os envios falharem com 423 ou 429. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{sender, status, dailyLimit, reason, cleanSince, warnedAt, pausedAt, evaluatedAt}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_sender_reputation",
  "arguments": {}
}
Somente leituralist_suppressions
GET /suppressions

Listar supressões

Lista de supressão do workspace: destinatários bloqueados após um bounce permanente ou uma reclamação de spam. Os envios para eles falham com 422. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{email, reason, detail, created_at}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_suppressions",
  "arguments": {}
}
Destrutivaremove_suppression
DELETE /suppressions/:email

Remover uma supressão por bounce

DESTRUTIVA (enfraquece um bloqueio de segurança): remove uma supressão por bounce para que o endereço possa receber e-mails de novo. Faça isso somente quando uma pessoa confirmar que o endereço agora é válido. Supressões por reclamação não podem ser removidas (409).

ParâmetroTipoObrigatórioDescrição
emailstringsimEndereço do destinatário suprimido. (máx. 320 caracteres)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "remove_suppression",
  "arguments": {
    "email": "fixed-mailbox@example.net"
  }
}
Somente leituralist_blocked_recipients
GET /blocked-recipients

Listar destinatários bloqueados

Todos os destinatários que o SendHQ vai recusar: bounces, reclamações e descadastros de marketing por domínio, com um resumo por tipo. Lê até os 500 mais recentes. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{email, domain, kind: bounce|complaint|unsubscribe, reason, detail, source, status, created_at}], count, summary: {total, bounce, complaint, unsubscribe}, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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}.

ParâmetroTipoObrigatórioDescrição
list_idstringnãoOnly members of this list (lst_…).
statusstringnãoOnly 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)
querystringnãoEmail or name contains this text; * is a wildcard on the email. (max 200 chars)
tagstringnãoOnly contacts with this tag. (max 60 chars)
sourcestringnãoHow the contact was added. (one of form, api, import)
afterstringnãoSigned up at or after this time. ISO 8601 date or date-time. (max 40 chars)
beforestringnãoSigned up before this time. ISO 8601 date or date-time. (max 40 chars)
segment_idstringnãoOnly contacts matching this saved segment (seg_…).
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [contacts with tags, engagement, dormant, country], count, total, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
emailstringsimEmail address. (max 320 chars)
namestringnãoDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectnãoCustom 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[]nãoTags to attach, e.g. ["VIP"]. Up to 50. (0–50 items)
list_idsstring[]nãoLists to add the contact to (lst_…). (0–100 items)
statusstringnãosubscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed)
consent_basisstringnãoHow 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.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
emailstringsimEmail address. (max 320 chars)
namestringnãoDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectnãoCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
tagsstring[]nãoTags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items)
timezonestringnãoIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
localestringnãoLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
consent_basisstringnãoHow 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).
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
contact_idstringsimContact ID (starts with ct_) or the contact's email address. (max 320 chars)
ReturnsThe contact.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
contact_idstringsimContact ID (starts with ct_) or the contact's email address. (max 320 chars)
namestringnãoNew display name. (max 200 chars)
fieldsobjectnãoCustom 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[]nãoReplace all of the contact's tags with these. (0–50 items)
add_tagsstring[]nãoTags to add. (0–50 items)
remove_tagsstring[]nãoTags to remove. (0–50 items)
statusstringnãoOnly unsubscribed is accepted. (one of unsubscribed)
ReturnsThe updated contact.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
contact_idstringsimContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
csvstringsimThe CSV file content, header row first. (max 5242880 chars)
list_idstringnãoAdd every accepted row to this list (lst_…).
consent_basisstringsimHow 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[]nãoTags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items)
update_existingbooleannãoMerge names and fields into contacts that already exist. Their status never changes.
Returns{id, accepted, created, existing, skipped, invalid, errors: [{line, reason}], tags}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [imports], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
actionstringsimWhat to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete)
contact_idsstring[]nãoContact IDs (ct_…). Use this or filter. (0–10000 items)
filterobjectnãoEveryone matching these list_contacts filters. Use this or contact_ids.
filter.list_idstringnãoMembers of this list.
filter.statusstringnãoOnly 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.querystringnãoEmail or name contains; * is an email wildcard. (max 200 chars)
filter.tagstringnãoHas this tag. (max 60 chars)
filter.sourcestringnãoHow the contact was added. (one of form, api, import)
filter.afterstringnãoSigned up at or after. ISO 8601 date or date-time. (max 40 chars)
filter.beforestringnãoSigned up before. ISO 8601 date or date-time. (max 40 chars)
filter.segment_idstringnãoMatches this segment.
tagsstring[]nãoFor tag and untag. (0–50 items)
list_idstringnãoFor add_to_list and remove_from_list (lst_…).
confirm_countintegernãoFor 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
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{tag, count}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{key, label, type, createdAt}], count, types, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
field_keystringsimField 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)
labelstringnãoLabel shown in the dashboard. Defaults to the key. (max 80 chars)
typestringnãotext (default), number, or date. (one of text, number, date)
Returns{key, label, type, createdAt}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
field_keystringsimField 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)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{id, name, match, conditions, count}], count, fields, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
segment_idstringsimSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Returns{id, name, match, conditions, count}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
matchstringnãoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]nãoUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsimtag, 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[].keystringnãoCustom field key when field is field. (max 40 chars)
conditions[].opstringsimtag: 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,numbernãoRequired 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]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
namestringsimSegment name. (max 120 chars)
matchstringnãoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]nãoUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsimtag, 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[].keystringnãoCustom field key when field is field. (max 40 chars)
conditions[].opstringsimtag: 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,numbernãoRequired 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.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
segment_idstringsimSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
namestringnãoSegment name. (max 120 chars)
matchstringnãoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]nãoUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsimtag, 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[].keystringnãoCustom field key when field is field. (max 40 chars)
conditions[].opstringsimtag: 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,numbernãoRequired 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.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
segment_idstringsimSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [lists], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
namestringsimList name, shown on the signup form. (max 200 chars)
descriptionstringnãoShort description shown on the signup form. (max 500 chars)
form_enabledbooleannãoPublish the hosted signup form.
form_fromstringnãoSender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars)
redirect_urlstringnãohttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectnãoWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleannãoSend it.
welcome.subjectstringnãoSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringnãoHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringnãoMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectnãoPublic 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.enabledbooleannãoPublish the site.
site.slugstring,nullnãoAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullnãoSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullnãoShort description under the title. (max 300 chars)
site.accentstring,nullnãoAccent color, e.g. #0a7d4f.
ReturnsThe list.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
list_idstringsimList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
ReturnsThe list.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
list_idstringsimList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
namestringnãoNew name. (max 200 chars)
descriptionstringnãoNew description. (max 500 chars)
form_enabledbooleannãoPublish or unpublish the hosted signup form.
form_fromstringnãoSender of signup confirmation emails, on a verified domain. (max 320 chars)
redirect_urlstringnãohttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectnãoWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleannãoSend it.
welcome.subjectstringnãoSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringnãoHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringnãoMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectnãoPublic 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.enabledbooleannãoPublish the site.
site.slugstring,nullnãoAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullnãoSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullnãoShort description under the title. (max 300 chars)
site.accentstring,nullnãoAccent color, e.g. #0a7d4f.
ReturnsThe updated list.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
list_idstringsimList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
list_idstringsimList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idsstring[]nãoContact IDs (ct_…). (0–500 items)
emailsstring[]nãoContact email addresses. (0–500 items)
Returns{listId, added, notFound, list}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
list_idstringsimList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idstringsimContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
statusstringnãoOnly broadcasts with this status. (one of draft, sending, sent, cancelled, failed)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [broadcasts], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
namestringnãoInternal name. Defaults to the subject. (max 200 chars)
list_idstringnãoThe list to send to (lst_…).
fromstringnãoSender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars)
reply_tostringnãoReply-To address. (max 320 chars)
subjectstringnãoSubject line; merge tags allowed. (max 998 chars)
preview_textstringnãoInbox preview text shown after the subject. (max 300 chars)
htmlstringnãoHTML body; merge tags allowed and escaped.
textstringnãoPlain-text body; merge tags allowed.
templateobjectnãoA published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields.
template.idstringnão
template.keystringnão
template.version_idstringnão
markdownstringnãoMarkdown 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,nullnãoBlock 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.
editorstringnãoWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectnãoWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullnãoOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringnãoWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullnãoSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectnãoOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleannãoAdd an open pixel.
tracking.clicksbooleannãoRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectnãoPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleannãoPublish it.
web.slugstring,nullnãoIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleannãoKeep it at the top of the site.
ReturnsThe draft broadcast.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe broadcast.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
namestringnãoInternal name. (max 200 chars)
list_idstringnãoThe list to send to.
fromstringnãoSender on a verified domain. (max 320 chars)
reply_tostringnãoReply-To address. (max 320 chars)
subjectstringnãoLinha de assunto. (máx. 998 caracteres)
preview_textstringnãoInbox preview text. (max 300 chars)
htmlstringnãoCorpo em HTML.
textstringnãoCorpo em texto simples.
templateobject,nullnãoA published hosted template, or null to remove it.
markdownstringnãoMarkdown 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,nullnãoBlock 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.
editorstringnãoWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectnãoWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullnãoOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringnãoWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullnãoSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectnãoOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleannãoAdd an open pixel.
tracking.clicksbooleannãoRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectnãoPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleannãoPublish it.
web.slugstring,nullnãoIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleannãoKeep it at the top of the site.
ReturnsThe updated draft.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
idempotency_keystringnãoCabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres)
ReturnsThe broadcast with status sending and totals.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe cancelled broadcast with totals.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
statusstringnãoOnly recipients with this outcome. (one of queued, sending, sent, held, skipped, failed)
activitystringnãoOnly recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed)
querystringnãoRecipient email contains this text. (max 200 chars)
includestringnãolinks adds the links each recipient clicked (implied by activity: clicked). (one of links)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{contactId, email, status, skipReason, emailId, error, provider, deliveredAt, openedAt, clickedAt, opens, clicks, bouncedAt, complainedAt, unsubscribedAt, links?}], count, totals, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast 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}}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
tostring[]nãoTest recipients (up to 5). (1–5 items)
contact_idstringnãoFill merge tags from this contact (ct_…). (max 320 chars)
rememberbooleannãoSave to as the default test recipients.
Returns{data: [{to, id, status: sent|failed, error?}]}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
scheduled_atstringsimWhen 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.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe draft broadcast.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe new draft broadcast.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
limitintegersimHow many more people at most. (1–10000000)
idempotency_keystringnãoCabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres)
Returns{added, broadcast}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
broadcast_idstringsimBroadcast 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

Sem parâmetros.

Returns{postalAddress, design: {accentColor, font, align}, cleanup: {enabled, afterSends, quietDays, subject, body, from}, testRecipients}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
postal_addressstringnãoSender's postal address for the footer. Empty string removes it. (max 300 chars)
designobjectnãoRendering design for Markdown and block content.
design.accentColorstring,nullnãoHex color like #0a7d4f, or null for the default.
design.fontstringnãoFont family. (one of sans, serif, mono)
design.alignstringnãoText alignment. (one of left, center)
cleanupobjectnãoList cleanup of readers who stopped opening.
cleanup.enabledbooleannãoTurn list cleanup on or off.
cleanup.afterSendsintegernãoBroadcasts in a row without an open or click (3-50). (3–50)
cleanup.quietDaysintegernãoDays without engagement (30-730). (30–730)
cleanup.subjectstring,nullnãoSubject of the cleanup email; merge tags allowed. (max 200 chars)
cleanup.bodystring,nullnãoBody text of the cleanup email. (max 2000 chars)
cleanup.fromstring,nullnãoSender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars)
test_recipientsstring[]nãoDefault addresses for send_broadcast_test (up to 5). (0–5 items)
ReturnsThe updated settings.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
daysintegernãoWindow 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{id, url, width, height, size, filename, createdAt}], pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
emailstringsimThe contact's email address. (max 320 chars)
eventstringsimWhat they did: a lowercase letter, then a-z, 0-9, and _ (e.g. checkout_started). Names starting email. are reserved. (max 64 chars)
propertiesobjectnãoUp 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_atstringnãoWhen 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_keystringnãoStable ID for this event (max 200 chars). A second call with the same key records nothing and returns the first result. (max 200 chars)
contactobjectnãoChanges to the contact, applied with the event.
contact.namestringnãoDisplay name. (max 200 chars)
contact.fieldsobjectnãoCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
contact.timezonestringnãoIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
contact.localestringnãoLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
contact.consent_basisstringnãoHow 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]}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
domainstringnãoOnly 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)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation 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}].
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
keystringsimAddress of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars)
namestringsimName shown in the dashboard. (max 200 chars)
audience_labelstringnãoWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringnãoWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectnãoHow 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.typestringsimEntry type. (one of event, bucket, date_field, manual)
entry.eventstringnãoEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringnãoSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringnãoContact field key for a date_field entry. (max 40 chars)
entry.reentrystringnãoWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectnãoWhen 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,nullnãoEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleannãoTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]nãoEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegernãoDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectnãoPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleannãoSkip 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,nullnãoAt 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,nullnãoStored 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_pctnumbernãoPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegernãoAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegernãoHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegernãoPriority. 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_namestringnãoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnãoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnãoReply-To address. (max 320 chars)
stepsobject[]nãoThe emails, in order. position defaults to the place in this list. (0–50 items)
steps[].positionintegernãoPosition of the email in the automation, 1 to 50. (1–50)
steps[].subjectstringnãoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
steps[].preheaderstringnãoInbox preview line. (max 300 chars)
steps[].contentobjectnãoBlock 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[].htmlstringnãoHTML body. The unsubscribe footer is added automatically.
steps[].textstringnãoCorpo em texto simples.
steps[].editorstringnãoHow 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_secondsintegernãoWhen 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[]nãoMerge 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_windowbooleannãoSend 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}].
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
namestringnãoName shown in the dashboard. (max 200 chars)
audience_labelstringnãoWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringnãoWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectnãoHow 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.typestringsimEntry type. (one of event, bucket, date_field, manual)
entry.eventstringnãoEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringnãoSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringnãoContact field key for a date_field entry. (max 40 chars)
entry.reentrystringnãoWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectnãoWhen 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,nullnãoEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleannãoTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]nãoEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegernãoDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectnãoPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleannãoSkip 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,nullnãoAt 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,nullnãoStored 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_pctnumbernãoPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegernãoAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegernãoHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegernãoPriority. 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_namestringnãoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnãoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnãoReply-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}].
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersimPosition of the email in the automation, 1 to 50. (1–50)
templatestringnãoId 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)
subjectstringnãoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringnãoInbox preview line. (max 300 chars)
contentobjectnãoBlock 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.
htmlstringnãoHTML body. The unsubscribe footer is added automatically.
textstringnãoCorpo em texto simples.
editorstringnãoHow 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_secondsintegernãoWhen 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[]nãoMerge 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_windowbooleannãoSend 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}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersimPosition of the email in the automation, 1 to 50. (1–50)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersimPosition of the email in the automation, 1 to 50. (1–50)
localestringsimLanguage tag of the version, e.g. fr or pt-br. (max 35 chars)
subjectstringnãoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringnãoInbox preview line. (max 300 chars)
contentobjectnãoBlock 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.
htmlstringnãoHTML body. The unsubscribe footer is added automatically.
textstringnãoCorpo em texto simples.
Returns{locale, subject, preheader, content, html, text, updated_at}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
statusstringsimon 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}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersimPosition of the email in the automation, 1 to 50. (1–50)
localestringnãoSend 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)
sampleobjectnãoValues 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_runbooleannãoSend 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}]}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
localestringnãoSend 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)
sampleobjectnãoValues 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}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringsimEmail address of an existing contact. (max 320 chars)
propertiesobjectnãoUp 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_atstringnãoThe 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}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringsimEmail address of the contact. (max 320 chars)
reasonstringnãoWhy, 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}.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
fromstringnãoFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringnãoLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
domainstringnãoOnly 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}]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
fromstringnãoFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringnãoLast 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}]}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
didstringnãoWhat the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting)
stepintegernãoOnly this email of the automation, by its position. (1–50)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
automation_keystringsimAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
contact_idstringsimContact 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}}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

Sem parâmetros.

Returns{max_emails, period_days, min_gap_hours, window_start, window_end, weekdays, default_timezone, product_name, sender_name, updated_at}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
max_emailsintegernãoMost automation emails one person may get in period_days. Default 2. (1–50)
period_daysintegernãoThe period max_emails applies to, in days. Default 7. (1–90)
min_gap_hoursintegernãoLeast time between two automation emails to one person, in hours. Default 44. (0–720)
window_startintegernãoFirst hour of the day emails may go out, local time (0-23). Default 9. (0–23)
window_endintegernãoHour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24)
weekdaysinteger[]nãoDays emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items)
default_timezonestringnãoIANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars)
product_namestringnãoYour product's name, for {{ product_name }}. (max 120 chars)
sender_namestringnãoWho the emails are from, for {{ sender_name }}. (max 120 chars)
ReturnsThe updated limits.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
template_idstringsimId 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.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
template_idstringsimId 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)
keystringnãoAddress 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)
namestringnãoName shown in the dashboard. Defaults to the template's own name. (max 200 chars)
from_namestringnãoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnãoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnãoReply-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.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
contactstringnãoOnly this contact: a contact ID or an email address. (max 320 chars)
namestringnãoOnly this event, e.g. checkout_started. See list_event_names. (max 64 chars)
fromstringnãoEvents from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars)
tostringnãoEvents up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars)
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Returns{data: [{event, words, count}], count, days, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
connection_idstringsimConnection 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}].
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
namestringsimWhat to call it, e.g. Stripe. (max 80 chars)
kindstringsimstripe, dodo, or generic. (one of generic, stripe, dodo)
consent_basisstringsimHow 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_prefixstringnãoPut in front of every event name, e.g. stripe_. (max 32 chars)
enabledbooleannãoDefaults to true. Pass false to create it switched off.
mappingobjectnãoFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringnãoWhere the contact's email address is. (max 120 chars)
mapping.eventstringnãoWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringnãoOne fixed event name, instead of event. (max 64 chars)
mapping.timestringnãoWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringnãoWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]nãoThe 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.
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
connection_idstringsimConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
namestringnãoA new name. (max 80 chars)
enabledbooleannãotrue: record what arrives. false: answer 404 and record nothing.
consent_basisstringnãoHow 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_prefixstringnãoPut in front of every event name, e.g. stripe_. (max 32 chars)
mappingobjectnãoFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringnãoWhere the contact's email address is. (max 120 chars)
mapping.eventstringnãoWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringnãoOne fixed event name, instead of event. (max 64 chars)
mapping.timestringnãoWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringnãoWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]nãoThe 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}.
AnotaçõesidempotentHint
Exemplo de params de 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.

ParâmetroTipoObrigatórioDescrição
connection_idstringsimConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Retorno{ok: true}.
AnotaçõesdestructiveHint idempotentHint
Exemplo de params de tools/call
{
  "name": "delete_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}

Conta, uso, análises e chaves

Somente leituraget_account
GET /account

Obter conta, uso e cobrança

E-mail do dono da conta, plano/nível de acesso, entregas a destinatários no período atual usadas vs. cota, domínios usados vs. limite, transferência de anexos, resumo de reputação, estado da assinatura, planos publicados e contagens do workspace. Use para verificar a cota restante ou para quem o teste pode entregar (o e-mail da conta).

Sem parâmetros.

Retorno{user: {email, …}, usage: {domainsUsed, domainLimit, recipientDeliveries, emailQuotaMonth, attachmentBytes, attachmentByteLimit, periodKey}, access: {tier, planCode}, reputation, infrastructure, billing: {status, subscriptions, …}, plans, workspace: {mailer, stats}}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de 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.

Sem parâmetros.

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}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_account_diagnostics",
  "arguments": {}
}
Somente leituraget_analytics
GET /analytics

Obter análises de envio

Análises do painel dos últimos 7, 30 ou 90 dias: totais de enviados/recebidos/entregues/bounces/bloqueados/abertos/cliques/reclamações, uma linha do tempo diária, os principais domínios de envio e os principais assuntos.

ParâmetroTipoObrigatórioDescrição
daysintegernãoJanela em dias: 7, 30 (padrão) ou 90. (um de 7, 30, 90)
Retorno{window, days, metrics, timeline: [{day, sent, received}], domains, topContent}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_analytics",
  "arguments": {
    "days": 30
  }
}
Somente leituralist_api_keys
GET /keys

Listar metadados de chaves de API

Lista nomes de chaves de API, prefixos não secretos e horários do último uso. Somente leitura: este servidor MCP não pode criar, rotacionar nem revogar chaves; uma pessoa faz isso no painel. Paginado: o resultado inclui pagination {offset, limit, returned, total?, has_more, next_offset}.

ParâmetroTipoObrigatórioDescrição
limitintegernãoTamanho da página. O padrão é 50. (padrão 50; 1–200)
offsetintegernãoNúmero de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…)
Retorno{data: [{id, name, prefix, lastUsedAt, createdAt}], count, pagination}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "list_api_keys",
  "arguments": {}
}
Somente leituraget_service_health
GET /health

Verificar a saúde do serviço SendHQ

Verifica se a API do SendHQ está no ar e qual provedor de e-mail está ativo. Não precisa de uma chave de API válida.

Sem parâmetros.

Retorno{ok, service, mailer}.
AnotaçõesreadOnlyHint idempotentHint
Exemplo de params de tools/call
{
  "name": "get_service_health",
  "arguments": {}
}

Inventário de cobertura da API

Todas as operações da API pública e a ferramenta que as cobre. Tudo o que uma pessoa pode fazer no painel e que tem uma API está coberto; as exclusões abaixo são deliberadas.

EndpointFerramentaObservações
POST /emailssend_emailEnviar um e-mail
POST /emails/batchsend_batchEnviar até 100 mensagens individualizadas
GET /emailslist_emailsListar e-mails enviados e recebidos
GET /emails/:idget_emailRecuperar um e-mail e seus anexos
PATCH /emails/:idmark_emailAtualizar lido, arquivado, spam, categoria ou importância
POST /emails/:id/labelslabel_emailAdicionar ou remover marcadores de um e-mail
DELETE /emails/:iddelete_emailExcluir um e-mail retido
GET /emails/:id/eventslist_email_eventsListar eventos de entrega de um e-mail
GET /threads/:idget_threadRecuperar uma conversa em ordem cronológica
GET /labelslist_labelsListar marcadores com contagens de mensagens e regras de arquivamento
POST /labelscreate_labelCriar um marcador, opcionalmente com regras de arquivamento automático
GET /labels/:idget_labelRecuperar um marcador por ID ou nome
PATCH /labels/:idupdate_labelRenomear, mudar a cor ou transformar um marcador em categoria
DELETE /labels/:iddelete_labelExcluir um marcador sem excluir seus e-mails
POST /labels/:id/rulescreate_label_ruleAdicionar uma regra de arquivamento automático a um marcador
DELETE /labels/:id/rules/:rule_iddelete_label_ruleExcluir uma regra de arquivamento automático
POST /draftscreate_draftCriar um rascunho do compositor
GET /draftslist_draftsListar rascunhos do compositor
GET /drafts/:idget_draftRecuperar um rascunho e seus anexos
PUT /drafts/:idupdate_draftSubstituir o conteúdo do rascunho
DELETE /drafts/:iddelete_draftDescartar um rascunho
POST /drafts/:id/attachmentsupload_attachmentFazer upload de um anexo para um rascunho
GET /attachments/:iddownload_attachmentBaixar um anexo privado
DELETE /attachments/:iddelete_attachmentExcluir um anexo privado
GET /sending-identitieslist_sending_identitiesListar identidades de remetente verificadas
GET /templateslist_templatesListar templates hospedados
POST /templatescreate_templateCriar um template hospedado
GET /templates/:idget_templateRecuperar rascunhos, releases e uso
PUT /templates/:id/draftupdate_template_draftSalvar automaticamente um rascunho de template
POST /templates/:id/draftcreate_template_draftCriar um novo rascunho a partir da release publicada
POST /templates/:id/renderrender_templateRenderizar a saída exata do servidor
POST /templates/:id/testsend_template_testEnviar um snapshot de teste
POST /templates/:id/publishpublish_templatePublicar uma release imutável de template
POST /templates/:id/archivearchive_templateArquivar um template
POST /templates/:id/restorerestore_templateRestaurar um template arquivado
POST /domainsadd_domainAdicionar um domínio de envio
GET /domainslist_domainsListar domínios e o estado de DNS em cache
GET /domains/:idget_domainRecuperar os detalhes de configuração de um domínio
POST /domains/:id/verifyverify_domainRefresh domain and DNS verification
POST /domains/:id/inbound/setupsetup_inboundProvision inbound receiving
POST /domains/:id/inbound/verifyverify_inboundVerificar o roteamento do MX de entrada
DELETE /domains/:iddelete_domainExcluir um domínio
GET /dns/providerget_dns_providerDetectar o provedor de DNS autoritativo e os hosts relativos dos registros
GET /dns/domain-connect/connectget_domain_connect_linkCriar um link de consentimento do Domain Connect para configuração de DNS com um clique
POST /inboxescreate_inboxCriar um endereço de entrada
GET /inboxeslist_inboxesListar endereços de entrada
GET /inboxes/:idget_inboxRecuperar um endereço de entrada
PATCH /inboxes/:idupdate_inboxRenomear, ativar ou desativar uma caixa de entrada
PUT /inboxes/:id/forwardingset_inbox_forwardingEncaminhar os e-mails recebidos de uma caixa de entrada para outro endereço
DELETE /inboxes/:iddelete_inboxExcluir uma caixa de entrada mantendo as mensagens
GET /deliverability/statsdeliverability_statsRecuperar estatísticas de entrega dos últimos 30 dias
GET /deliverability/reputationlist_sender_reputationListar o estado de reputação por identidade de remetente exata
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_suppressionsListar as supressões do workspace
DELETE /suppressions/:emailremove_suppressionRemover uma supressão por bounce elegível
GET /blocked-recipientslist_blocked_recipientsListar bounces, reclamações e descadastros
GET /webhooksnão expostoWebhook 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 /webhooksnão expostoWebhook 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/:idnão expostoWebhook 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/:idnão expostoWebhook 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/:idnão expostoWebhook 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-secretnão expostoWebhook 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/testnão expostoWebhook 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/deliveriesnão expostoWebhook 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/:deliveryIdnão expostoWebhook 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/retrynão expostoWebhook 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/exportnão expostoImage 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/imagesnão expostoImage 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/batchnão expostoHistory 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-historynão expostoHistory 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/previewnão expostoThese 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/testnão expostoThese 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/addressnão expostoThe 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_accountRecuperar conta, uso, estado de cobrança e contagens do workspace com uma chave de API
GET /account/diagnosticsget_account_diagnosticsDiagnose sending and receiving problems in the workspace
GET /analyticsget_analyticsRecuperar as análises de envio do painel para 7, 30 ou 90 dias
GET /profileget_accountEquivalente de GET /account apenas para sessão; o servidor MCP lê a rota da chave de API.
POST /billing/checkoutnão expostoAs alterações de cobrança são apenas por sessão, por design, e exigem o dono da conta no painel. O estado de cobrança pode ser lido com get_account.
POST /billing/cancelnão expostoAs alterações de cobrança são apenas por sessão, por design, e exigem o dono da conta no painel. O estado de cobrança pode ser lido com get_account.
POST /keysnão expostoExcluída deliberadamente: um agente não deve emitir nem destruir credenciais. As chaves são gerenciadas por uma pessoa no painel.
GET /keyslist_api_keysListar metadados de chaves de API
DELETE /keys/:idnão expostoExcluída deliberadamente: um agente não deve emitir nem destruir credenciais. As chaves são gerenciadas por uma pessoa no painel.

Deliberadamente indisponível

RecursoEndpointsMotivo
Criar, rotacionar, revogar ou excluir chaves de APIPOST /keys, DELETE /keys/:idExcluída deliberadamente: um agente não deve emitir nem destruir credenciais. As chaves são gerenciadas por uma pessoa no painel.
Iniciar um checkout ou cancelar uma assinaturaPOST /billing/checkout, POST /billing/cancelAs alterações de cobrança são apenas por sessão, por design, e exigem o dono da conta no painel. O estado de cobrança pode ser lido com get_account.
Configuração de DNS com um clique da Cloudflare (OAuth)GET /api/dns/cloudflare/connectExige uma sessão interativa no navegador e o consentimento OAuth da Cloudflare. Use os registros de get_domain, os hosts de get_dns_provider ou get_domain_connect_link.
Cadastro, login, logout e vinculação de conta Google/api/auth/*Autenticação humana no navegador; o servidor MCP se autentica com uma chave de API.
Formulário de contato com o suportePOST /api/contactFormulário público do site de marketing, para pessoas, não uma operação do workspace.
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.

Catálogo legível por máquina: /docs/mcp/tools.json (schemas, anotações, mapeamento de endpoints, exclusões). Versão em Markdown desta página: /docs/mcp.md. Com a CLI instalada, sendhq commands --format json imprime o mesmo catálogo.