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.
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcpO 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
codeestável, ostatusHTTP, umaexplanation, umremedyconcreto 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-onlyoculta 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.
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
- Abra Settings → Connectors e encontre o SendHQ no diretório, ou escolha Add custom connector e cole
https://mcp.sendhq.cc/mcp. - Clique em Connect, entre no SendHQ, revise o acesso e clique em Allow.
- Peça ao Claude para verificar sua caixa de entrada, enviar um e-mail do seu domínio verificado ou explicar um bounce.
ChatGPT
- Open Settings → Security and login and turn on Developer mode.
- Go to chatgpt.com/plugins, click Create MCP app, name it SendHQ and enter
https://mcp.sendhq.cc/mcp. - Sign in to SendHQ and click Allow, then pick SendHQ from the tools menu in a new chat.
Grok
- Go to grok.com/connectors, click New Connector, then Custom.
- 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_featuretool 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.
curl -fsSL https://downloads.sendhq.cc/install.sh | shirm https://downloads.sendhq.cc/install.ps1 | iexsendhq version
SENDHQ_API_KEY=re_your_key sendhq doctorCrie 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 é:
SENDHQ_API_KEY=re_your_key sendhq mcpNormalmente 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 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-onlyAdicione --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.
{
"mcpServers": {
"sendhq": {
"command": "sendhq",
"args": [
"mcp"
],
"env": {
"SENDHQ_API_KEY": "${SENDHQ_API_KEY}"
}
}
}
}OpenAI Codex
[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).
{
"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.
{"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 flag | Obrigatório | Significado |
|---|---|---|
SENDHQ_API_KEY | sim | Chave 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_URL | não | URL 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_ONLY | não | 1, true ou yes se comporta como --read-only. |
--read-only | não | Expõ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 / --profile | não | Usa 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), andsend_broadcast_to_moredeliver mail to real people and consume delivery credits. Their descriptions start withSENDS 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), andbulk_update_contactsare markeddestructiveHint: trueand their descriptions start withDESTRUCTIVE. Confirm with the user first.remove_suppressionweakens 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: truee pode ser chamado livremente. - O DNS nunca é alterado por este servidor.
add_domainretorna registros para uma pessoa publicar;get_domain_connect_linkretorna uma URL de consentimento que uma pessoa precisa abrir e aprovar no provedor de DNS. - A cobrança nunca é alterada por este servidor.
get_accountlê 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 (machineinget_broadcast_report). - Não troque o endereço De para contornar uma pausa
423e 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
get_service_healthconfirma que a API está acessível (funciona sem chave).get_accountshows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returnssubscription_required.list_sending_identitieslista os endereços De que você pode usar. Se estiver vazia, faça primeiro o fluxo de domínio.- Confirme remetente, destinatário, assunto e corpo com o usuário e, depois, use
send_emailcom umidempotency_key. list_email_eventscom oidretornado mostradelivery,bounce,complaintourejectassim que o provedor informa (em geral, de segundos a minutos).
{
"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
add_domainwithname: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).get_dns_providercom odomain_iddetecta o provedor de DNS autoritativo e retorna o host relativo exato a informar para cada registro nesse provedor.- If
providers.domainConnect.availableis true,get_domain_connect_linkreturns 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 existingv=spf1value. verify_domainrechecks DNS and DKIM verification. Status moves throughpending,checking, andpropagatingtoverified. Pollverify_domainorget_domainevery 30–60 seconds; DNS can take minutes to hours.- Quando
statusforverified, os endereços do domínio aparecem emlist_sending_identities.
3. Bounces, reclamações e supressões
list_blocked_recipientsretorna todos os endereços bloqueados com o motivo (bounce,complaint,unsubscribe) e uma contagem resumida.list_suppressionsretorna as supressões por hard bounce e por reclamação;deliverability_statstraz as taxas de entrega, bounce e reclamação dos últimos 30 dias;list_sender_reputationmostra quais endereços De estão com o ritmo reduzido ou pausados.- Um envio que contém um destinatário suprimido falha com
422 recipient_suppressed. Remova esse destinatário e envie de novo. - 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
- O domínio (muitas vezes um subdomínio, como
inbound.example.com) precisa estar verificado. setup_inboundprovisiona o recebimento e retorna um registro MX. Uma pessoa o publica.verify_inboundaté questatussejaready.create_inboxcomdomain_idelocal_part(por exemplo,support) criasupport@inbound.example.com.- Consulte
list_emailscomdirection: "in"eunread: true(opcionalmenteinbox_id). Leia uma mensagem comget_email, a conversa comget_thread, os anexos comdownload_attachmente marque-a como tratada commark_email(read: true). - Responda na mesma thread com
send_emailereply_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
- Encontre a mensagem:
list_emailscomdirection: "out"etoouquery, ouget_emailse você tiver o ID.status: failedsignifica que o SendHQ ou o provedor a rejeitou na submissão; o erro do e-mail explica o motivo. list_email_events:bounce(permanente ou transitório, com o diagnóstico do provedor),complaint,rejectoudelivery. Nenhum evento ainda significa que o provedor não informou nada; aguarde e verifique de novo.- 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→ inspectlist_sender_reputation;account_paused→ the workspace is paused for review, read the rates;daily_limit_reached→ wait until midnight UTC;quota_exhausted→get_accountusage. get_domainverifica se DKIM, SPF e DMARC ainda estão publicados;deliverability_statsmostra se o problema é uma única mensagem ou uma tendência.- Relate o que as evidências mostram. Um evento
deliverysignifica 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)
create_labelcomname(por exemplo,Agent/Orders) eskip_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.- Envie e-mails de tarefas com
send_email(ousend_batch) elabels: ["Agent/Orders"]. As respostas a essa conversa herdam o marcador automaticamente e não vão para a Caixa de entrada. - Para e-mails que começam fora das suas conversas, adicione uma regra de arquivamento:
create_label_rulecominbox_id(um endereço dedicado, comoorders@…),from,toousubject. Passeapply_to_existing: truepara arquivar e-mails já recebidos. - Trabalhe a categoria:
list_emailscomlabel: "Agent/Orders",direction: "in"eunread: true; leia comget_emailouget_thread, responda comsend_emailereply_to_email_ide usemark_emailcomread: truequando concluir. - 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. - Opcionalmente,
set_inbox_forwardingenvia uma cópia de tudo o que um endereço de recebimento recebe para outra caixa postal (o destino confirma antes por e-mail).
{
"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
- Audience:
list_lists(orcreate_listwith a signup form), and optionallypreview_segmentthencreate_segmentto narrow it, for example to contacts taggedVIPwho opened in the last 90 days. Add only people who asked for your email: every subscribed contact needs aconsent_basis. get_newsletter_settings: ifpostalAddressis empty, ask the user for one and set it withupdate_newsletter_settings(marketing email needs it).create_broadcastwithlist_id, a verifiedfrom,subject,preview_text, content (markdownis simplest), and optionallyaudience(segment_id,limit,order: engaged).check_broadcast: fix everyblockitem and tell the user aboutwarnitems. Thensend_broadcast_testto the user's own address so they can look at it.- Only when the user says to send:
send_broadcastnow (with anidempotency_key), orschedule_broadcastwithscheduled_at(unschedule_broadcastto change it). - Follow up with
get_broadcast(delivery totals),get_broadcast_report(opens, clicks, links, inbox providers, against your average), andlist_broadcast_recipientswithactivity. Report opens as estimates. With a limited audience,send_broadcast_to_moresends to the next people.
{
"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.
create_automationwith akey, theentryevent,exit_rules(thegoal_eventthat counts as converting, orno_goal: true), a verifiedfrom_address, andsteps, each dueoffset_secondsafter the person entered. It starts as a draft and sends nothing. Every automation carriesdomain, the domain of itsfrom_address; in a workspace that sends from several domains,list_automationsandget_automations_overviewtakedomainto show the automations of one of them.- To let the user read it first:
send_automation_test_emailsends one email, andsend_automation_testevery 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_emailwithdry_run: truereturns the rendered email without sending anything. get_sending_limitsshows how much automation email one person may get across every automation, and during which hours. Change them withupdate_sending_limitsonly when the user asks.- To start from a ready-made email instead of writing one:
list_automation_templatesis 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_templateshows one with the email as this workspace would send it, anduse_automation_templatemakes 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_stepwithtemplateloads one template into an email of an automation that already exists. - An email can also be built in the dashboard's drag-and-drop builder.
get_automationshows such an email witheditordesign: itscontentis the builder's project, which only the builder writes, and itshtmlis 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 ownhtmlwitheditorhtml. - 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_fillon 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 withset_automation_step, and setproduct_nameandsender_namewithupdate_sending_limits. Never invent them.set_automation_statusrefuses to turn the automation on while anything is left (422automation_not_ready, with aproblemslist that names each email and detail); test emails are allowed, so the user can read it first. - Only when the user says to start:
set_automation_statuswithstatus: "on". - Record what people do with
track_event(a new contact needscontact.consent_basis). The entry event starts the sequence, the goal event ends it as converted, and adedupe_keymakes a retry harmless.enroll_contactandexit_contactadd or remove one person by hand. preview_automationshows, 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.list_automationsgives 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.- Results:
get_automations_overview(every automation) andget_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_peoplelists who did what (did: entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, or waiting), andget_automation_persongives 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 labelledmachineand never counted.
{
"name": "use_automation_template",
"arguments": {
"template_id": "payment-failed-notices",
"from_name": "Dana from Acme",
"from_address": "dana@example.com"
}
}{
"name": "preview_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}{
"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.
list_eventsis 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 bycontact, byname, or by date.list_event_nameslists the kinds of event seen in the last 30 days.list_connectionsshows each connection with its last delivery in plain words, andget_connectionits last 50 deliveries: "Recorded 2 events", "Skipped: no email address", "Refused: bad signature". Start there when something a provider sent did not show up.- Only when the user asks to connect a system:
create_connectionwithkindstripeordodo(mapped for you) orgenericwith amapping. It returns the secretaddressonce; 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. update_connectionwithenabled: falsepauses a connection (its address answers 404);delete_connectionremoves it. The provider's signing secret and a replacement address are set by a person in the dashboard.
{
"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.
{
"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.
{
"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.
{
"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: trueeretryable: false. Verifiquelist_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_emailcomattachmentsinline não pode receber umidempotency_key, porque executa várias requisições. Para envios de anexos seguros para novas tentativas:create_draft→upload_attachment→send_emailcomdraft_ideidempotency_key.
{
"name": "send_email",
"arguments": {
"from": "Acme <billing@example.com>",
"to": [
"owner@example.com"
],
"subject": "Receipt #4812",
"text": "Thanks for your payment.",
"idempotency_key": "receipt-4812"
}
}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.recipientDeliveriesvs.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_requireduntil 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 afterresets_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_reachedwaits 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_limitedmeans Gmail returned 4.7.28; wait untilresets_atand 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_batchaté 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.
| code | HTTP | Repetir? | O que significa e o que fazer |
|---|---|---|---|
invalid_arguments | — | não | Os argumentos falharam no JSON Schema da ferramenta localmente; nada chegou ao SendHQ. Corrija os campos listados em problems. |
auth_error | 401 | não | Chave de API ausente, revogada ou incorreta. Defina SENDHQ_API_KEY para o processo do servidor; uma pessoa cria as chaves no painel. |
subscription_required | 402 | não | No active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then. |
payment_required | 402 | não | O recurso exige um plano pago (por exemplo, anexos). Envie sem ele ou faça upgrade. |
sender_domain_not_owned | 403 | não | O domínio De não está neste workspace. Use list_sending_identities ou add_domain. |
sender_domain_unverified | 403 | não | O domínio De ainda não foi verificado. get_domain, publique os registros que faltam, verify_domain. |
domain_limit_reached | 403 | não | Limite de domínios do plano atingido. Remova um domínio sem uso (com aprovação) ou faça upgrade. |
marketing_not_enabled | 403 | não | A classe de marketing não está habilitada para este domínio ou plano. Use transactional somente se a mensagem realmente for transacional. |
forbidden | 403 | não | A política não permite a operação. Ajuste a requisição. |
not_found | 404 | não | O ID não está neste workspace. Liste o recurso para encontrar o ID correto; restaure antes os templates arquivados. |
idempotency_conflict | 409 | não | Chave reutilizada com um corpo diferente. Reenvie exatamente o original ou use uma nova chave para uma nova mensagem. |
idempotency_in_progress | 409 | sim | A requisição original ainda está em execução. Aguarde e tente de novo com a mesma chave e o mesmo corpo. |
revision_conflict | 409 | não | O rascunho do template mudou desde que você o leu. get_template, faça o merge e salve de novo. |
complaint_suppression_locked | 409 | não | O destinatário reclamou. Nunca mais envie e-mail para ele. |
inbound_not_ready | 409 | não | O recebimento de e-mails de entrada não está pronto. setup_inbound, publique o MX, verify_inbound. |
conflict | 409 | não | O recurso já existe ou está no estado errado. Leia-o e ajuste. |
attachments_too_large | 413 | não | Mais de 10 arquivos ou 10 MB. Remova ou reduza os anexos. |
recipient_suppressed | 422 | não | Um destinatário teve hard bounce ou reclamou antes. Remova-o; veja list_blocked_recipients. |
recipient_unsubscribed | 422 | não | Um destinatário optou por não receber e-mails de marketing. Remova-o permanentemente. |
validation_failed | 422 | não | Conteúdo rejeitado, por exemplo dados de template que quebram o contrato de variáveis. Corrija a entrada. |
sender_paused | 423 | não | Este 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_paused | 423 | não | Workspace paused for a deliverability review. The body has the measured rate and the limit when the pause was for bounces or complaints. Do not send until it is restored. |
quota_exhausted | 429 | não | Monthly allowance, per-sender daily limit, or attachment transfer. Not the workspace daily ladder. Check get_account; wait for that limit to reset or upgrade. |
daily_limit_reached | 429 | after reset | Workspace daily ladder. Not a short backoff. Wait until resets_at (midnight UTC). The message was not queued. |
hourly_limit_reached | 429 | after reset | Hourly pace (about a tenth of the day's cap). Wait until the next UTC hour. Not a short backoff. |
gmail_recipient_limit | 429 | after reset | 500 Gmail recipients a day for a sending domain under 30 days old, on any ladder rung. Wait until midnight UTC. Not queued. |
gmail_rate_limited | 429 | after reset | Gmail returned 4.7.28 for this domain. Wait until resets_at. Other providers keep sending. |
rate_limited | 429 | sim | Slow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap. |
server_error | 5xx | sim | Falha 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 | — | sim | Requisição ou resposta perdida. Tente de novo; em envios, o mesmo idempotency_key torna isso seguro. |
invalid_request | 400 | não | Requisição malformada. Leia message e corrija. |
tool_error | — | não | Falha 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
Nenhuma ferramenta corresponde a este filtro.
E-mails e threads
send_emailEnviar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from | string | sim | Remetente, por exemplo Acme <hello@example.com>. O domínio precisa estar verificado neste workspace (veja list_sending_identities). (máx. 998 caracteres) |
to | string[] | sim | Destinatá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) |
cc | string[] | não | Destinatários em cópia. (0–100 itens) |
bcc | string[] | não | Destinatários em cópia oculta. (0–100 itens) |
subject | string | não | Linha de assunto. Omita ao enviar um template. (máx. 998 caracteres) |
text | string | não | Corpo em texto simples. Informe text, html ou template. |
html | string | não | Corpo em HTML. O SendHQ o sanitiza e gera o texto quando text é omitido. |
reply_to | string | não | Endereço de Reply-To. |
headers | object | não | Cabeç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_class | string | não | transactional (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_id | string | não | Responde 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_id | string | não | ID explícito da thread em que a mensagem será arquivada. |
draft_id | string | não | Envia os anexos de um rascunho armazenado com esta mensagem (dr_…). O rascunho é excluído após um envio bem-sucedido. |
template | object | não | Envia 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.id | string | não | ID do template (tmpl_…). Informe id ou key. |
template.key | string | não | Chave do template, como account-welcome. Informe id ou key. |
template.version_id | string | não | ID de release publicada opcional (tmplv_…). Por padrão, é a release publicada atual. |
template.data | object | não | Valores das variáveis tipadas do template. |
labels | string[] | não | Nomes 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_key | string | não | Cabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres) |
attachments | object[] | não | Arquivos 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[].filename | string | não | Nome 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_type | string | não | Tipo MIME, por exemplo application/pdf. O padrão é application/octet-stream. |
attachments[].content_base64 | string | não | Conteúdo do arquivo em base64 padrão. |
attachments[].file_path | string | não | Caminho absoluto de um arquivo local legível pelo processo do servidor MCP. |
{
"name": "send_email",
"arguments": {
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"subject": "Your export is ready",
"text": "Download it from your dashboard.",
"idempotency_key": "export-ready-42"
}
}send_batchEnviar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
emails | object[] | sim | Mensagens a enviar. (1–100 itens) Informe pelo menos um destes: html, text, template. |
idempotency_key | string | não | Idempotency-Key para todo o lote (máx. 200 caracteres). (máx. 200 caracteres) |
{
"name": "send_batch",
"arguments": {
"emails": [
{
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"template": {
"key": "account-welcome",
"data": {
"first_name": "Asha"
}
}
}
],
"idempotency_key": "welcome-batch-2026-09-26"
}
}list_emailsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
direction | string | não | in para recebidos, out para enviados. (um de in, out) |
status | string | não | Filtro de status, por exemplo queued, sent, delivered, bounced, complained, failed. |
domain | string | não | Apenas mensagens deste domínio, ou de uma lista de domínios separados por vírgula (corresponde a qualquer um). |
inbox_id | string | não | Apenas mensagens recebidas por esta caixa de entrada (inb_…). |
label | string | não | Apenas 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. |
archived | boolean | não | false = a visualização da Caixa de entrada (e-mails recebidos não arquivados), true = apenas arquivados. Omita para todos os e-mails. |
category | string | não | primary (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. |
important | boolean | não | true = apenas mensagens marcadas como importantes (respostas a conversas que você iniciou e remetentes marcados como importantes). |
include_spam | boolean | não | Inclui spam nos resultados (para pesquisas em todas as pastas). |
from | string | não | O endereço do remetente contém este valor. |
to | string | não | O endereço do destinatário contém este valor. |
unread | boolean | não | true = apenas não lidas, false = apenas lidas. |
after | string | não | Timestamp ISO-8601; apenas mensagens criadas depois dele. (date-time) |
before | string | não | Timestamp ISO-8601; apenas mensagens criadas antes dele. (date-time) |
query | string | não | Pesquisa de texto livre em assuntos, corpos, endereços de remetente/destinatário e nomes de arquivos de anexos. (máx. 200 caracteres) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_emails",
"arguments": {
"direction": "in",
"unread": true,
"limit": 25
}
}get_emailObter 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | ID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_email",
"arguments": {
"email_id": "em_123"
}
}mark_emailMarcar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | ID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
read | boolean | não | true = lida, false = não lida. |
archived | boolean | não | true = arquivar (não vai para a Caixa de entrada), false = mover de volta para a Caixa de entrada. |
category | string | não | Move uma mensagem recebida para primary, updates ou spam. (um de primary, updates, spam) |
important | boolean | não | Marca ou desmarca a mensagem como importante. |
learn | boolean | não | false = não memorizar este veredito para o remetente (padrão true). |
{
"name": "mark_email",
"arguments": {
"email_id": "em_123",
"read": true
}
}delete_emailExcluir 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | ID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "delete_email",
"arguments": {
"email_id": "em_123"
}
}list_email_eventsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | ID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_email_events",
"arguments": {
"email_id": "em_123"
}
}get_threadObter uma conversa
Recupera todas as mensagens de uma conversa em ordem cronológica (enviadas e recebidas), cada uma com os metadados dos anexos.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
thread_id | string | sim | ID da thread (em geral, o ID em_… da primeira mensagem; veja threadId em qualquer e-mail). (máx. 128 caracteres) |
{
"name": "get_thread",
"arguments": {
"thread_id": "em_123"
}
}email_deliveryGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | |
limit | integer | não | |
offset | integer | não |
{
"name": "email_delivery",
"arguments": {
"email_id": "em_123"
}
}thread_deliveryGet a thread delivery summary
Counts of delivered, bounced, complained, and failed outbound messages in one conversation, plus each message's failure reason.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
thread_id | string | sim |
{
"name": "thread_delivery",
"arguments": {
"thread_id": "thr_123"
}
}Marcadores e regras de arquivamento automático
list_labelsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_labels",
"arguments": {}
}get_labelObter um marcador
Recupera um marcador com contagens e regras de arquivamento automático.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
label_id | string | sim | ID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres) |
{
"name": "get_label",
"arguments": {
"label_id": "Billing"
}
}create_labelCriar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | Nome do marcador, por exemplo Billing ou Clients/Acme. Único por workspace (sem diferenciar maiúsculas de minúsculas). (máx. 64 caracteres) |
color | string | não | Cor hexadecimal, como #1a73e8. Opcional. |
skip_inbox | boolean | não | Modo 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. |
rules | object[] | não | Regras 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[].direction | string | não | Apenas e-mails in (recebidos) ou out (enviados). Omita para ambos. (um de in, out) |
rules[].inbox_id | string | não | Apenas e-mails recebidos por esta caixa de entrada (inb_…). Arquiva cada endereço de recebimento em sua própria pasta. |
rules[].from | string | não | O remetente contém este texto (sem diferenciar maiúsculas de minúsculas), por exemplo @stripe.com. (máx. 200 caracteres) |
rules[].to | string | não | To/Cc contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres) |
rules[].subject | string | não | O assunto contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres) |
rules[].skip_inbox | boolean | não | Arquiva os e-mails recebidos correspondentes para que apareçam apenas na pasta do marcador, não na Caixa de entrada. |
apply_to_existing | boolean | não | Arquiva também os e-mails já retidos que correspondem às regras. |
{
"name": "create_label",
"arguments": {
"name": "Agent/Orders",
"skip_inbox": true,
"rules": [
{
"from": "@stripe.com"
}
]
}
}update_labelRenomear, 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
label_id | string | sim | ID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres) |
name | string | não | Novo nome. (máx. 64 caracteres) |
color | string | não | Nova cor hexadecimal. |
skip_inbox | boolean | não | Modo 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. |
{
"name": "update_label",
"arguments": {
"label_id": "lbl_123",
"name": "Finance/Billing"
}
}delete_labelExcluir um marcador
DESTRUTIVA: exclui um marcador e suas regras. O e-mail em si é mantido; ele apenas perde este marcador.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
label_id | string | sim | ID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres) |
{
"name": "delete_label",
"arguments": {
"label_id": "lbl_123"
}
}create_label_ruleAdicionar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
label_id | string | sim | ID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres) |
direction | string | não | Apenas e-mails in (recebidos) ou out (enviados). Omita para ambos. (um de in, out) |
inbox_id | string | não | Apenas e-mails recebidos por esta caixa de entrada (inb_…). Arquiva cada endereço de recebimento em sua própria pasta. |
from | string | não | O remetente contém este texto (sem diferenciar maiúsculas de minúsculas), por exemplo @stripe.com. (máx. 200 caracteres) |
to | string | não | To/Cc contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres) |
subject | string | não | O assunto contém este texto (sem diferenciar maiúsculas de minúsculas). (máx. 200 caracteres) |
skip_inbox | boolean | não | Arquiva os e-mails recebidos correspondentes para que apareçam apenas na pasta do marcador, não na Caixa de entrada. |
apply_to_existing | boolean | não | Arquiva também os e-mails já retidos que correspondem. |
{
"name": "create_label_rule",
"arguments": {
"label_id": "Billing",
"inbox_id": "inb_123",
"skip_inbox": true
}
}delete_label_ruleExcluir uma regra de arquivamento automático
DESTRUTIVA: remove uma regra de arquivamento automático. Os e-mails já arquivados mantêm o marcador.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
label_id | string | sim | ID do marcador (começa com lbl_) ou o nome exato do marcador. (máx. 128 caracteres) |
rule_id | string | sim | ID da regra (começa com lrule_), obtido em get_label. (máx. 128 caracteres) |
{
"name": "delete_label_rule",
"arguments": {
"label_id": "lbl_123",
"rule_id": "lrule_123"
}
}label_emailAdicionar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | sim | ID do e-mail (começa com em_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
add | string[] | não | Marcadores a adicionar. (0–10 itens) |
remove | string[] | não | Marcadores a remover. (0–10 itens) |
create | boolean | não | Cria os marcadores desconhecidos em add (padrão true). |
{
"name": "label_email",
"arguments": {
"email_id": "em_123",
"add": [
"Billing"
],
"remove": [
"Support"
]
}
}Rascunhos, anexos e identidades de remetente
list_sending_identitiesListar 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.
{
"name": "list_sending_identities",
"arguments": {}
}create_draftCriar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from | string | não | Endereço de remetente em um domínio verificado (pode ficar vazio durante a edição). |
to | string[] | não | Destinatários. (0–100 itens) |
cc | string[] | não | Destinatários em cópia. (0–100 itens) |
bcc | string[] | não | Destinatários em cópia oculta. (0–100 itens) |
subject | string | não | Linha de assunto. (máx. 998 caracteres) |
html | string | não | Corpo em HTML. |
text | string | não | Corpo em texto simples. |
reply_to_email_id | string | não | ID do e-mail ao qual este rascunho responde. |
thread_id | string | não | ID da thread à qual este rascunho pertence. |
{
"name": "create_draft",
"arguments": {
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice"
}
}list_draftsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_drafts",
"arguments": {}
}get_draftObter um rascunho
Recupera um rascunho com os metadados dos anexos.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
draft_id | string | sim | ID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_draft",
"arguments": {
"draft_id": "dr_123"
}
}update_draftSubstituir 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
draft_id | string | sim | ID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
from | string | não | Endereço de remetente em um domínio verificado (pode ficar vazio durante a edição). |
to | string[] | não | Destinatários. (0–100 itens) |
cc | string[] | não | Destinatários em cópia. (0–100 itens) |
bcc | string[] | não | Destinatários em cópia oculta. (0–100 itens) |
subject | string | não | Linha de assunto. (máx. 998 caracteres) |
html | string | não | Corpo em HTML. |
text | string | não | Corpo em texto simples. |
reply_to_email_id | string | não | ID do e-mail ao qual este rascunho responde. |
thread_id | string | não | ID da thread à qual este rascunho pertence. |
{
"name": "update_draft",
"arguments": {
"draft_id": "dr_123",
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice (updated)",
"text": "Attached."
}
}delete_draftDescartar um rascunho
DESTRUTIVA: descarta um rascunho e exclui permanentemente seus anexos armazenados.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
draft_id | string | sim | ID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "delete_draft",
"arguments": {
"draft_id": "dr_123"
}
}upload_attachmentFazer 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
draft_id | string | sim | ID do rascunho (começa com dr_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
filename | string | não | Nome do arquivo exibido ao destinatário. Por padrão, é o nome-base de file_path. (máx. 255 caracteres) |
content_type | string | não | Tipo MIME, por exemplo application/pdf. O padrão é application/octet-stream. |
content_base64 | string | não | Conteúdo do arquivo em base64 padrão. |
file_path | string | não | Caminho absoluto de um arquivo local legível pelo processo do servidor MCP. |
{
"name": "upload_attachment",
"arguments": {
"draft_id": "dr_123",
"filename": "invoice.pdf",
"content_type": "application/pdf",
"file_path": "/tmp/invoice.pdf"
}
}download_attachmentBaixar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
attachment_id | string | sim | ID do anexo (começa com att_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
save_to_path | string | não | Caminho local absoluto opcional para gravar o arquivo em vez de retornar base64. |
overwrite | boolean | não | Permite substituir um arquivo existente em save_to_path. O padrão é false. |
{
"name": "download_attachment",
"arguments": {
"attachment_id": "att_123",
"save_to_path": "/tmp/invoice.pdf"
}
}delete_attachmentExcluir um anexo
DESTRUTIVA: exclui permanentemente um anexo armazenado (por exemplo, para remover um arquivo de um rascunho antes de enviar).
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
attachment_id | string | sim | ID do anexo (começa com att_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "delete_attachment",
"arguments": {
"attachment_id": "att_123"
}
}Templates hospedados
list_templatesListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
lifecycle | string | não | active (padrão), archived ou all. (um de active, archived, all) |
query | string | não | Pesquisa por nome ou chave. (máx. 120 caracteres) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_templates",
"arguments": {
"lifecycle": "active"
}
}create_templateCriar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | Nome legível. (máx. 120 caracteres) |
key | string | não | Chave de envio estável: letras minúsculas, números e hifens; começa com uma letra (2–64 caracteres). Derivada do nome quando omitida. |
starter | string | não | Conteúdo inicial. (um de blank, welcome, reset, receipt) |
{
"name": "create_template",
"arguments": {
"name": "Account welcome",
"key": "account-welcome",
"starter": "welcome"
}
}get_templateObter 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID do template (tmpl_…) ou chave. (máx. 128 caracteres) |
{
"name": "get_template",
"arguments": {
"template_id": "account-welcome"
}
}update_template_draftSalvar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
revision | integer | sim | Revisão atual do rascunho, obtida em get_template. (1–…) |
name | string | não | Nome do template. (máx. 120 caracteres) |
subject_template | string | não | Assunto com placeholders. (máx. 998 caracteres) |
preheader_template | string | não | Texto de pré-visualização. (máx. 240 caracteres) |
html_template | string | não | Corpo em HTML com placeholders. |
text_template | string | não | Corpo em texto simples com placeholders. |
from | string | não | Remetente padrão para os envios deste template. |
reply_to | string | não | Reply-To padrão. |
variables | object[] | não | Contrato de variáveis tipadas. Cada item: {key (minúsculas/sublinhados), label, type: text|number|url|boolean, required (padrão true), fallback, description}. |
variables[].key | string | sim | |
variables[].label | string | não | |
variables[].type | string | não | (um de text, number, url, boolean) |
variables[].required | boolean | não | |
variables[].fallback | any | não | |
variables[].description | string | não | |
sample_data | object | não | Valores de exemplo usados em pré-visualizações e testes. |
{
"name": "update_template_draft",
"arguments": {
"template_id": "account-welcome",
"revision": 3,
"name": "Account welcome",
"subject_template": "Welcome, {{first_name}}",
"text_template": "Hi {{first_name}}",
"variables": [
{
"key": "first_name",
"type": "text",
"required": true
}
],
"sample_data": {
"first_name": "Asha"
}
}
}create_template_draftIniciar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
{
"name": "create_template_draft",
"arguments": {
"template_id": "account-welcome"
}
}render_templateRenderizar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
version_id | string | não | ID de versão opcional; por padrão, usa o rascunho e, depois, a release publicada. |
data | object | não | Valores das variáveis; por padrão, os dados de exemplo da versão. |
{
"name": "render_template",
"arguments": {
"template_id": "account-welcome",
"data": {
"first_name": "Asha"
}
}
}send_template_testEnviar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
to | string[] | sim | Destinatários do teste. (1–100 itens) |
from | string | não | Remetente em um domínio verificado; por padrão, o De do template. |
version_id | string | não | ID de versão opcional. |
data | object | não | Valores das variáveis; por padrão, os dados de exemplo. |
{
"name": "send_template_test",
"arguments": {
"template_id": "account-welcome",
"to": [
"owner@example.com"
]
}
}publish_templatePublicar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
{
"name": "publish_template",
"arguments": {
"template_id": "account-welcome"
}
}archive_templateArquivar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
{
"name": "archive_template",
"arguments": {
"template_id": "account-welcome"
}
}restore_templateRestaurar um template arquivado
Torna um template arquivado ativo de novo.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | ID ou chave do template. (máx. 128 caracteres) |
{
"name": "restore_template",
"arguments": {
"template_id": "account-welcome"
}
}Domínios e DNS
list_domainsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_domains",
"arguments": {}
}get_domainObter 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_domain",
"arguments": {
"domain_id": "dom_123"
}
}add_domainAdicionar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | Nome de domínio simples, por exemplo example.com ou mail.example.com. (máx. 253 caracteres) |
default_from | string | não | Endereço de remetente padrão opcional neste domínio. |
{
"name": "add_domain",
"arguments": {
"name": "example.com"
}
}verify_domainVerificar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "verify_domain",
"arguments": {
"domain_id": "dom_123"
}
}delete_domainExcluir 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "delete_domain",
"arguments": {
"domain_id": "dom_123"
}
}get_dns_providerDetectar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_dns_provider",
"arguments": {
"domain_id": "dom_123"
}
}get_domain_connect_linkObter um link de configuração de DNS com um clique
Quando get_dns_provider informa providers.domainConnect.available, cria uma URL de consentimento assinada. Entregue-a a uma pessoa: ela a abre e aprova a alteração de DNS no provedor. Nada muda até que ela aprove. 409 se não houver suporte.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_domain_connect_link",
"arguments": {
"domain_id": "dom_123"
}
}E-mail de entrada
setup_inboundHabilitar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "setup_inbound",
"arguments": {
"domain_id": "dom_123"
}
}verify_inboundVerificar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "verify_inbound",
"arguments": {
"domain_id": "dom_123"
}
}list_inboxesListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | não | Filtro opcional por ID de domínio. |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_inboxes",
"arguments": {
"domain_id": "dom_123"
}
}get_inboxObter uma caixa de entrada
Recupera um endereço de entrada.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
inbox_id | string | sim | ID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "get_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}create_inboxCriar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | sim | ID do domínio (começa com dom_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
local_part | string | sim | Parte antes do @, por exemplo support. (máx. 64 caracteres) |
name | string | não | Nome de exibição opcional. |
{
"name": "create_inbox",
"arguments": {
"domain_id": "dom_123",
"local_part": "support",
"name": "Support"
}
}update_inboxRenomear, ativar ou desativar uma caixa de entrada
Renomeia uma caixa de entrada ou define seu status como active / disabled.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
inbox_id | string | sim | ID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
name | string | não | Novo nome de exibição. |
status | string | não | Novo status. (um de active, disabled) |
{
"name": "update_inbox",
"arguments": {
"inbox_id": "inb_123",
"status": "disabled"
}
}set_inbox_forwardingEncaminhar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
inbox_id | string | sim | ID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
forward_to | string,null | sim | Endereço de e-mail de destino do encaminhamento, ou null para desativá-lo. (máx. 254 caracteres) |
{
"name": "set_inbox_forwarding",
"arguments": {
"inbox_id": "inb_123",
"forward_to": "team@example.net"
}
}delete_inboxExcluir 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
inbox_id | string | sim | ID da caixa de entrada (começa com inb_), conforme retornado por uma ferramenta de listagem ou criação. (máx. 128 caracteres) |
{
"name": "delete_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}Entregabilidade, bounces e supressões
deliverability_statsObter 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.
{
"name": "deliverability_stats",
"arguments": {}
}deliverability_accountGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | integer | não | (one of 7, 30, 90) |
{
"name": "deliverability_account",
"arguments": {
"days": 30
}
}deliverability_domainsGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | integer | não | |
domain | string | não | |
limit | integer | não | |
offset | integer | não |
{
"name": "deliverability_domains",
"arguments": {
"days": 30
}
}deliverability_sendersGet sender delivery rates
Per From address: sent, delivered, hard and soft bounces, complaints, failures, and rates.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | integer | não | |
domain | string | não | |
limit | integer | não | |
offset | integer | não |
{
"name": "deliverability_senders",
"arguments": {
"days": 30
}
}score_emailScore 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subject | string | não | The subject line. |
html | string | não | The HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars) |
text | string | não | The plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars) |
from | string | não | The sender: an email address or a domain such as example.com. Without it, links to other sites are not judged. (max 320 chars) |
{
"name": "score_email",
"arguments": {
"from": "hello@example.com",
"subject": "Your cart is still here",
"html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
}
}list_sender_reputationListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_sender_reputation",
"arguments": {}
}list_suppressionsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_suppressions",
"arguments": {}
}remove_suppressionRemover 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | sim | Endereço do destinatário suprimido. (máx. 320 caracteres) |
{
"name": "remove_suppression",
"arguments": {
"email": "fixed-mailbox@example.net"
}
}list_blocked_recipientsListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_blocked_recipients",
"arguments": {}
}Campaigns
list_contactsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | não | Only members of this list (lst_…). |
status | string | não | Only contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant) |
query | string | não | Email or name contains this text; * is a wildcard on the email. (max 200 chars) |
tag | string | não | Only contacts with this tag. (max 60 chars) |
source | string | não | How the contact was added. (one of form, api, import) |
after | string | não | Signed up at or after this time. ISO 8601 date or date-time. (max 40 chars) |
before | string | não | Signed up before this time. ISO 8601 date or date-time. (max 40 chars) |
segment_id | string | não | Only contacts matching this saved segment (seg_…). |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_contacts",
"arguments": {
"status": "subscribed"
}
}create_contactAdd 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | sim | Email address. (max 320 chars) |
name | string | não | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | não | Custom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field. |
tags | string[] | não | Tags to attach, e.g. ["VIP"]. Up to 50. (0–50 items) |
list_ids | string[] | não | Lists to add the contact to (lst_…). (0–100 items) |
status | string | não | subscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed) |
consent_basis | string | não | How these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars) |
{
"name": "create_contact",
"arguments": {
"email": "ada@example.net",
"name": "Ada Lovelace",
"consent_basis": "Ticked the newsletter box at checkout on acme.com"
}
}upsert_contactCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | sim | Email address. (max 320 chars) |
name | string | não | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | não | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
tags | string[] | não | Tags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items) |
timezone | string | não | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
locale | string | não | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
consent_basis | string | não | How this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars) |
{
"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"
}
}get_contactGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | sim | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "get_contact",
"arguments": {
"contact_id": "ct_123"
}
}update_contactUpdate, 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | sim | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
name | string | não | New display name. (max 200 chars) |
fields | object | não | Custom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field. |
tags | string[] | não | Replace all of the contact's tags with these. (0–50 items) |
add_tags | string[] | não | Tags to add. (0–50 items) |
remove_tags | string[] | não | Tags to remove. (0–50 items) |
status | string | não | Only unsubscribed is accepted. (one of unsubscribed) |
{
"name": "update_contact",
"arguments": {
"contact_id": "ct_123",
"fields": {
"plan": "team"
}
}
}delete_contactDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | sim | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "delete_contact",
"arguments": {
"contact_id": "ct_123"
}
}import_contactsImport 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
csv | string | sim | The CSV file content, header row first. (max 5242880 chars) |
list_id | string | não | Add every accepted row to this list (lst_…). |
consent_basis | string | sim | How these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars) |
tags | string[] | não | Tags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items) |
update_existing | boolean | não | Merge names and fields into contacts that already exist. Their status never changes. |
{
"name": "import_contacts",
"arguments": {
"csv": "email,name\nada@example.net,Ada Lovelace\n",
"consent_basis": "Newsletter signups exported from Mailchimp (double opt-in)"
}
}list_contact_importsList contact imports
Campaigns: Recent CSV imports with their consent basis and row counts.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_contact_imports",
"arguments": {}
}bulk_update_contactsBulk 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
action | string | sim | What to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete) |
contact_ids | string[] | não | Contact IDs (ct_…). Use this or filter. (0–10000 items) |
filter | object | não | Everyone matching these list_contacts filters. Use this or contact_ids. |
filter.list_id | string | não | Members of this list. |
filter.status | string | não | Only contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant) |
filter.query | string | não | Email or name contains; * is an email wildcard. (max 200 chars) |
filter.tag | string | não | Has this tag. (max 60 chars) |
filter.source | string | não | How the contact was added. (one of form, api, import) |
filter.after | string | não | Signed up at or after. ISO 8601 date or date-time. (max 40 chars) |
filter.before | string | não | Signed up before. ISO 8601 date or date-time. (max 40 chars) |
filter.segment_id | string | não | Matches this segment. |
tags | string[] | não | For tag and untag. (0–50 items) |
list_id | string | não | For add_to_list and remove_from_list (lst_…). |
confirm_count | integer | não | For delete: the number of contacts that will be deleted, from the 409 response. (0–…) |
{
"name": "bulk_update_contacts",
"arguments": {
"action": "tag",
"tags": [
"october"
],
"filter": {
"list_id": "lst_123",
"status": "subscribed"
}
}
}list_tagsList contact tags
Campaigns: The workspace's contact tags, most used first, with how many contacts carry each (up to 500). Paginated.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_tags",
"arguments": {}
}list_contact_fieldsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_contact_fields",
"arguments": {}
}set_contact_fieldDefine 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
field_key | string | sim | Field key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars) |
label | string | não | Label shown in the dashboard. Defaults to the key. (max 80 chars) |
type | string | não | text (default), number, or date. (one of text, number, date) |
{
"name": "set_contact_field",
"arguments": {
"field_key": "plan",
"label": "Plan",
"type": "text"
}
}delete_contact_fieldDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
field_key | string | sim | Field key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars) |
{
"name": "delete_contact_field",
"arguments": {
"field_key": "plan"
}
}list_segmentsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_segments",
"arguments": {}
}get_segmentGet a segment
Campaigns: One segment with its conditions and live count.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
segment_id | string | sim | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
{
"name": "get_segment",
"arguments": {
"segment_id": "seg_123"
}
}preview_segmentPreview 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
match | string | não | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | não | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sim | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | não | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sim | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | não | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "preview_segment",
"arguments": {
"match": "all",
"conditions": [
{
"field": "tag",
"op": "has",
"value": "VIP"
},
{
"field": "opened",
"op": "in_last_days",
"value": 90
}
]
}
}create_segmentCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | Segment name. (max 120 chars) |
match | string | não | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | não | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sim | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | não | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sim | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | não | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "create_segment",
"arguments": {
"name": "Engaged pro customers",
"conditions": [
{
"field": "fields.plan",
"op": "equals",
"value": "pro"
},
{
"field": "opened",
"op": "in_last_days",
"value": 90
}
]
}
}update_segmentUpdate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
segment_id | string | sim | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
name | string | não | Segment name. (max 120 chars) |
match | string | não | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | não | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sim | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | não | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sim | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | não | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "update_segment",
"arguments": {
"segment_id": "seg_123",
"name": "Pro customers"
}
}delete_segmentDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
segment_id | string | sim | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
{
"name": "delete_segment",
"arguments": {
"segment_id": "seg_123"
}
}list_listsList contact lists
Campaigns: Contact lists with subscribed, pending, and unsubscribed counts and their hosted signup form settings.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_lists",
"arguments": {}
}create_listCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | List name, shown on the signup form. (max 200 chars) |
description | string | não | Short description shown on the signup form. (max 500 chars) |
form_enabled | boolean | não | Publish the hosted signup form. |
form_from | string | não | Sender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars) |
redirect_url | string | não | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | não | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | não | Send it. |
welcome.subject | string | não | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | não | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | não | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | não | Public newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409. |
site.enabled | boolean | não | Publish the site. |
site.slug | string,null | não | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | não | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | não | Short description under the title. (max 300 chars) |
site.accent | string,null | não | Accent color, e.g. #0a7d4f. |
{
"name": "create_list",
"arguments": {
"name": "Product updates"
}
}get_listGet a list
Campaigns: One list with member counts and signup form settings.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | sim | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_list",
"arguments": {
"list_id": "lst_123"
}
}update_listUpdate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | sim | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
name | string | não | New name. (max 200 chars) |
description | string | não | New description. (max 500 chars) |
form_enabled | boolean | não | Publish or unpublish the hosted signup form. |
form_from | string | não | Sender of signup confirmation emails, on a verified domain. (max 320 chars) |
redirect_url | string | não | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | não | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | não | Send it. |
welcome.subject | string | não | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | não | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | não | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | não | Public newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409. |
site.enabled | boolean | não | Publish the site. |
site.slug | string,null | não | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | não | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | não | Short description under the title. (max 300 chars) |
site.accent | string,null | não | Accent color, e.g. #0a7d4f. |
{
"name": "update_list",
"arguments": {
"list_id": "lst_123",
"form_enabled": false
}
}delete_listDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | sim | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
{
"name": "delete_list",
"arguments": {
"list_id": "lst_123"
}
}add_list_contactsAdd 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | sim | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_ids | string[] | não | Contact IDs (ct_…). (0–500 items) |
emails | string[] | não | Contact email addresses. (0–500 items) |
{
"name": "add_list_contacts",
"arguments": {
"list_id": "lst_123",
"emails": [
"ada@example.net"
]
}
}remove_list_contactRemove a contact from a list
DESTRUCTIVE: remove one contact from a list. The contact and its status are kept. Part of Campaigns.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | sim | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_id | string | sim | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "remove_list_contact",
"arguments": {
"list_id": "lst_123",
"contact_id": "ct_123"
}
}list_broadcastsList broadcasts
Campaigns: Newest-first broadcasts with their status. Paginated: the result includes pagination.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
status | string | não | Only broadcasts with this status. (one of draft, sending, sent, cancelled, failed) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_broadcasts",
"arguments": {}
}create_broadcastCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | não | Internal name. Defaults to the subject. (max 200 chars) |
list_id | string | não | The list to send to (lst_…). |
from | string | não | Sender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars) |
reply_to | string | não | Reply-To address. (max 320 chars) |
subject | string | não | Subject line; merge tags allowed. (max 998 chars) |
preview_text | string | não | Inbox preview text shown after the subject. (max 300 chars) |
html | string | não | HTML body; merge tags allowed and escaped. |
text | string | não | Plain-text body; merge tags allowed. |
template | object | não | A published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields. |
template.id | string | não | |
template.key | string | não | |
template.version_id | string | não | |
markdown | string | não | Markdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars) |
content | object,null | não | Block document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent. |
editor | string | não | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | não | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | não | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | não | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | não | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | não | Open and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email. |
tracking.opens | boolean | não | Add an open pixel. |
tracking.clicks | boolean | não | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | não | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | não | Publish it. |
web.slug | string,null | não | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | não | Keep it at the top of the site. |
{
"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
}
}
}get_broadcastGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}update_broadcastEdit 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
name | string | não | Internal name. (max 200 chars) |
list_id | string | não | The list to send to. |
from | string | não | Sender on a verified domain. (max 320 chars) |
reply_to | string | não | Reply-To address. (max 320 chars) |
subject | string | não | Linha de assunto. (máx. 998 caracteres) |
preview_text | string | não | Inbox preview text. (max 300 chars) |
html | string | não | Corpo em HTML. |
text | string | não | Corpo em texto simples. |
template | object,null | não | A published hosted template, or null to remove it. |
markdown | string | não | Markdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars) |
content | object,null | não | Block document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent. |
editor | string | não | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | não | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | não | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | não | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | não | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | não | Open and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email. |
tracking.opens | boolean | não | Add an open pixel. |
tracking.clicks | boolean | não | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | não | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | não | Publish it. |
web.slug | string,null | não | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | não | Keep it at the top of the site. |
{
"name": "update_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"subject": "October product update"
}
}delete_broadcastDelete a draft broadcast
DESTRUCTIVE: permanently delete a draft broadcast. Broadcasts that were sent cannot be deleted. Part of Campaigns.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "delete_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcastSend 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
idempotency_key | string | não | Cabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres) |
{
"name": "send_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"idempotency_key": "october-update"
}
}cancel_broadcastCancel 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "cancel_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}list_broadcast_recipientsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
status | string | não | Only recipients with this outcome. (one of queued, sending, sent, held, skipped, failed) |
activity | string | não | Only recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed) |
query | string | não | Recipient email contains this text. (max 200 chars) |
include | string | não | links adds the links each recipient clicked (implied by activity: clicked). (one of links) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_broadcast_recipients",
"arguments": {
"broadcast_id": "bc_123",
"status": "failed"
}
}check_broadcastRun 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "check_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcast_testSend 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
to | string[] | não | Test recipients (up to 5). (1–5 items) |
contact_id | string | não | Fill merge tags from this contact (ct_…). (max 320 chars) |
remember | boolean | não | Save to as the default test recipients. |
{
"name": "send_broadcast_test",
"arguments": {
"broadcast_id": "bc_123",
"to": [
"owner@example.com"
]
}
}schedule_broadcastSchedule 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
scheduled_at | string | sim | When to send: ISO 8601 date-time with a timezone, at least a minute and at most a year ahead, e.g. 2026-11-10T09:00:00Z. (max 40 chars) |
{
"name": "schedule_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"scheduled_at": "2026-11-10T09:00:00Z"
}
}unschedule_broadcastUnschedule 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "unschedule_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}duplicate_broadcastDuplicate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "duplicate_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcast_to_moreSend 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
limit | integer | sim | How many more people at most. (1–10000000) |
idempotency_key | string | não | Cabeçalho Idempotency-Key (máx. 200 caracteres). Reutilize-o apenas para tentar de novo exatamente esta requisição. (máx. 200 caracteres) |
{
"name": "send_broadcast_to_more",
"arguments": {
"broadcast_id": "bc_123",
"limit": 500,
"idempotency_key": "october-update-more-1"
}
}get_broadcast_reportGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
broadcast_id | string | sim | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_broadcast_report",
"arguments": {
"broadcast_id": "bc_123"
}
}get_newsletter_settingsGet 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.
{
"name": "get_newsletter_settings",
"arguments": {}
}update_newsletter_settingsUpdate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
postal_address | string | não | Sender's postal address for the footer. Empty string removes it. (max 300 chars) |
design | object | não | Rendering design for Markdown and block content. |
design.accentColor | string,null | não | Hex color like #0a7d4f, or null for the default. |
design.font | string | não | Font family. (one of sans, serif, mono) |
design.align | string | não | Text alignment. (one of left, center) |
cleanup | object | não | List cleanup of readers who stopped opening. |
cleanup.enabled | boolean | não | Turn list cleanup on or off. |
cleanup.afterSends | integer | não | Broadcasts in a row without an open or click (3-50). (3–50) |
cleanup.quietDays | integer | não | Days without engagement (30-730). (30–730) |
cleanup.subject | string,null | não | Subject of the cleanup email; merge tags allowed. (max 200 chars) |
cleanup.body | string,null | não | Body text of the cleanup email. (max 2000 chars) |
cleanup.from | string,null | não | Sender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars) |
test_recipients | string[] | não | Default addresses for send_broadcast_test (up to 5). (0–5 items) |
{
"name": "update_newsletter_settings",
"arguments": {
"postal_address": "Acme Inc., 1 Main St, Springfield",
"design": {
"accentColor": "#0a7d4f"
}
}
}get_campaign_overviewGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | integer | não | Window in days, 7 to 365. Defaults to 30. (7–365) |
{
"name": "get_campaign_overview",
"arguments": {
"days": 30
}
}list_uploaded_imagesList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_uploaded_images",
"arguments": {}
}Automations, events, and sending limits
track_eventRecord 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | sim | The contact's email address. (max 320 chars) |
event | string | sim | What they did: a lowercase letter, then a-z, 0-9, and _ (e.g. checkout_started). Names starting email. are reserved. (max 64 chars) |
properties | object | não | Up to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved. |
occurred_at | string | não | When it happened, ISO 8601 with a time zone. Defaults to now; may not be in the future. The automation's emails are timed from it. (max 40 chars) |
dedupe_key | string | não | Stable ID for this event (max 200 chars). A second call with the same key records nothing and returns the first result. (max 200 chars) |
contact | object | não | Changes to the contact, applied with the event. |
contact.name | string | não | Display name. (max 200 chars) |
contact.fields | object | não | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
contact.timezone | string | não | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
contact.locale | string | não | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
contact.consent_basis | string | não | How this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars) |
{
"name": "track_event",
"arguments": {
"email": "ada@example.net",
"event": "checkout_started",
"properties": {
"plan": "pro"
},
"dedupe_key": "checkout_8f3a"
}
}list_automationsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain | string | não | Only the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_automations",
"arguments": {
"domain": "example.com"
}
}get_automationGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
{
"name": "get_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}create_automationCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key | string | sim | Address of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars) |
name | string | sim | Name shown in the dashboard. (max 200 chars) |
audience_label | string | não | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | não | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | não | How people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end. |
entry.type | string | sim | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | não | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | não | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | não | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | não | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | não | When people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules. |
exit_rules.goal_event | string,null | não | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | não | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | não | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | não | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | não | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | não | Skip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations. |
settings.daily_send_cap | integer,null | não | At most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…) |
settings.daily_entry_cap | integer,null | não | Stored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…) |
settings.holdout_pct | number | não | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | não | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | não | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | não | Priority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000) |
from_name | string | não | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | não | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | não | Reply-To address. (max 320 chars) |
steps | object[] | não | The emails, in order. position defaults to the place in this list. (0–50 items) |
steps[].position | integer | não | Position of the email in the automation, 1 to 50. (1–50) |
steps[].subject | string | não | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
steps[].preheader | string | não | Inbox preview line. (max 300 chars) |
steps[].content | object | não | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
steps[].html | string | não | HTML body. The unsubscribe footer is added automatically. |
steps[].text | string | não | Corpo em texto simples. |
steps[].editor | string | não | How the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design) |
steps[].offset_seconds | integer | não | When the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400) |
steps[].skip_if_empty | string[] | não | Merge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items) |
steps[].ignore_send_window | boolean | não | Send as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply. |
{
"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>"
}
]
}
}update_automationEdit 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
name | string | não | Name shown in the dashboard. (max 200 chars) |
audience_label | string | não | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | não | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | não | How people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end. |
entry.type | string | sim | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | não | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | não | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | não | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | não | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | não | When people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules. |
exit_rules.goal_event | string,null | não | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | não | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | não | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | não | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | não | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | não | Skip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations. |
settings.daily_send_cap | integer,null | não | At most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…) |
settings.daily_entry_cap | integer,null | não | Stored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…) |
settings.holdout_pct | number | não | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | não | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | não | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | não | Priority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000) |
from_name | string | não | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | não | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | não | Reply-To address. (max 320 chars) |
{
"name": "update_automation",
"arguments": {
"automation_key": "checkout-recovery",
"name": "Checkout recovery",
"settings": {
"holdout_pct": 10
}
}
}delete_automationDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
{
"name": "delete_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}set_automation_stepCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sim | Position of the email in the automation, 1 to 50. (1–50) |
template | string | não | Id of a template of the library, e.g. welcome-note (not a set). The email becomes that template; other fields passed here are applied on top. The email's wait is not the template's: pass offset_seconds. (max 63 chars) |
subject | string | não | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | não | Inbox preview line. (max 300 chars) |
content | object | não | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
html | string | não | HTML body. The unsubscribe footer is added automatically. |
text | string | não | Corpo em texto simples. |
editor | string | não | How the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design) |
offset_seconds | integer | não | When the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400) |
skip_if_empty | string[] | não | Merge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items) |
ignore_send_window | boolean | não | Send as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply. |
{
"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>"
}
}delete_automation_stepRemove 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sim | Position of the email in the automation, 1 to 50. (1–50) |
{
"name": "delete_automation_step",
"arguments": {
"automation_key": "checkout-recovery",
"position": 3
}
}set_automation_step_variantCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sim | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | sim | Language tag of the version, e.g. fr or pt-br. (max 35 chars) |
subject | string | não | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | não | Inbox preview line. (max 300 chars) |
content | object | não | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
html | string | não | HTML body. The unsubscribe footer is added automatically. |
text | string | não | Corpo em texto simples. |
{
"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>"
}
}set_automation_statusTurn 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
status | string | sim | on to start sending, off to stop. (one of on, off) |
{
"name": "set_automation_status",
"arguments": {
"automation_key": "checkout-recovery",
"status": "off"
}
}send_automation_test_emailSend 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sim | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | não | Send the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars) |
sample | object | não | Values to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set. |
dry_run | boolean | não | Send nothing; return the email as the test would deliver it. |
{
"name": "send_automation_test_email",
"arguments": {
"automation_key": "checkout-recovery",
"position": 1
}
}send_automation_testSend 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
locale | string | não | Send the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars) |
sample | object | não | Values to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set. |
{
"name": "send_automation_test",
"arguments": {
"automation_key": "checkout-recovery"
}
}enroll_contactAdd 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | sim | Email address of an existing contact. (max 320 chars) |
properties | object | não | Up to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved. |
anchor_at | string | não | The moment the emails' offsets count from, ISO 8601 with a time zone. Defaults to now; may lie ahead for emails that lead up to a date. (max 40 chars) |
{
"name": "enroll_contact",
"arguments": {
"automation_key": "checkout-recovery",
"email": "ada@example.net",
"properties": {
"plan": "pro"
}
}
}exit_contactTake 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | sim | Email address of the contact. (max 320 chars) |
reason | string | não | Why, for the record (max 200 chars). Defaults to manual. (max 200 chars) |
{
"name": "exit_contact",
"arguments": {
"automation_key": "checkout-recovery",
"email": "ada@example.net",
"reason": "Asked support to stop"
}
}preview_automationPreview 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "preview_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}get_automations_overviewGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from | string | não | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | não | Last day of the report as a UTC date (YYYY-MM-DD), inclusive. |
domain | string | não | Only the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars) |
{
"name": "get_automations_overview",
"arguments": {
"from": "2026-10-20",
"to": "2026-11-18"
}
}get_automation_reportGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
from | string | não | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | não | Last day of the report as a UTC date (YYYY-MM-DD), inclusive. |
{
"name": "get_automation_report",
"arguments": {
"automation_key": "checkout-recovery"
}
}list_automation_peopleList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
did | string | não | What the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting) |
step | integer | não | Only this email of the automation, by its position. (1–50) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_automation_people",
"arguments": {
"automation_key": "checkout-recovery",
"did": "clicked"
}
}get_automation_personGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_key | string | sim | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
contact_id | string | sim | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "get_automation_person",
"arguments": {
"automation_key": "checkout-recovery",
"contact_id": "ct_123"
}
}get_sending_limitsGet 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.
{
"name": "get_sending_limits",
"arguments": {}
}update_sending_limitsUpdate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
max_emails | integer | não | Most automation emails one person may get in period_days. Default 2. (1–50) |
period_days | integer | não | The period max_emails applies to, in days. Default 7. (1–90) |
min_gap_hours | integer | não | Least time between two automation emails to one person, in hours. Default 44. (0–720) |
window_start | integer | não | First hour of the day emails may go out, local time (0-23). Default 9. (0–23) |
window_end | integer | não | Hour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24) |
weekdays | integer[] | não | Days emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items) |
default_timezone | string | não | IANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars) |
product_name | string | não | Your product's name, for {{ product_name }}. (max 120 chars) |
sender_name | string | não | Who the emails are from, for {{ sender_name }}. (max 120 chars) |
{
"name": "update_sending_limits",
"arguments": {
"max_emails": 3,
"min_gap_hours": 24,
"default_timezone": "Europe/London"
}
}list_automation_templatesList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_automation_templates",
"arguments": {}
}get_automation_templateGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | Id of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars) |
{
"name": "get_automation_template",
"arguments": {
"template_id": "welcome-note"
}
}use_automation_templateCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | sim | Id of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars) |
key | string | não | Address of the new automation: 1-63 characters of a-z, 0-9, and -. Defaults to the template's id, with a number added when that is taken. (max 63 chars) |
name | string | não | Name shown in the dashboard. Defaults to the template's own name. (max 200 chars) |
from_name | string | não | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | não | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | não | Reply-To address. (max 320 chars) |
{
"name": "use_automation_template",
"arguments": {
"template_id": "welcome-note",
"name": "Welcome",
"from_name": "Dana from Acme",
"from_address": "dana@example.com"
}
}list_eventsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact | string | não | Only this contact: a contact ID or an email address. (max 320 chars) |
name | string | não | Only this event, e.g. checkout_started. See list_event_names. (max 64 chars) |
from | string | não | Events from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars) |
to | string | não | Events up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars) |
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_events",
"arguments": {
"name": "checkout_started",
"from": "2026-11-01"
}
}list_event_namesList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_event_names",
"arguments": {}
}list_connectionsList 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_connections",
"arguments": {}
}get_connectionGet 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
connection_id | string | sim | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
{
"name": "get_connection",
"arguments": {
"connection_id": "acn_123"
}
}create_connectionCreate 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | What to call it, e.g. Stripe. (max 80 chars) |
kind | string | sim | stripe, dodo, or generic. (one of generic, stripe, dodo) |
consent_basis | string | sim | How the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars) |
event_prefix | string | não | Put in front of every event name, e.g. stripe_. (max 32 chars) |
enabled | boolean | não | Defaults to true. Pass false to create it switched off. |
mapping | object | não | For a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name. |
mapping.email | string | não | Where the contact's email address is. (max 120 chars) |
mapping.event | string | não | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | não | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | não | Where the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars) |
mapping.id | string | não | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | não | The fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items) |
{
"name": "create_connection",
"arguments": {
"name": "Stripe",
"kind": "stripe",
"consent_basis": "Bought a plan on acme.com and accepted product emails"
}
}update_connectionChange 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
connection_id | string | sim | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
name | string | não | A new name. (max 80 chars) |
enabled | boolean | não | true: record what arrives. false: answer 404 and record nothing. |
consent_basis | string | não | How the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars) |
event_prefix | string | não | Put in front of every event name, e.g. stripe_. (max 32 chars) |
mapping | object | não | For a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name. |
mapping.email | string | não | Where the contact's email address is. (max 120 chars) |
mapping.event | string | não | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | não | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | não | Where the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars) |
mapping.id | string | não | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | não | The fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items) |
{
"name": "update_connection",
"arguments": {
"connection_id": "acn_123",
"enabled": false
}
}delete_connectionDelete 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
connection_id | string | sim | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
{
"name": "delete_connection",
"arguments": {
"connection_id": "acn_123"
}
}Conta, uso, análises e chaves
get_accountObter 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.
{
"name": "get_account",
"arguments": {}
}get_account_diagnosticsDiagnose 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.
{
"name": "get_account_diagnostics",
"arguments": {}
}get_analyticsObter 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | integer | não | Janela em dias: 7, 30 (padrão) ou 90. (um de 7, 30, 90) |
{
"name": "get_analytics",
"arguments": {
"days": 30
}
}list_api_keysListar 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | não | Tamanho da página. O padrão é 50. (padrão 50; 1–200) |
offset | integer | não | Número de registros a ignorar. Use pagination.next_offset da página anterior. (padrão 0; 0–…) |
{
"name": "list_api_keys",
"arguments": {}
}get_service_healthVerificar 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.
{
"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.
| Endpoint | Ferramenta | Observações |
|---|---|---|
| POST /emails | send_email | Enviar um e-mail |
| POST /emails/batch | send_batch | Enviar até 100 mensagens individualizadas |
| GET /emails | list_emails | Listar e-mails enviados e recebidos |
| GET /emails/:id | get_email | Recuperar um e-mail e seus anexos |
| PATCH /emails/:id | mark_email | Atualizar lido, arquivado, spam, categoria ou importância |
| POST /emails/:id/labels | label_email | Adicionar ou remover marcadores de um e-mail |
| DELETE /emails/:id | delete_email | Excluir um e-mail retido |
| GET /emails/:id/events | list_email_events | Listar eventos de entrega de um e-mail |
| GET /threads/:id | get_thread | Recuperar uma conversa em ordem cronológica |
| GET /labels | list_labels | Listar marcadores com contagens de mensagens e regras de arquivamento |
| POST /labels | create_label | Criar um marcador, opcionalmente com regras de arquivamento automático |
| GET /labels/:id | get_label | Recuperar um marcador por ID ou nome |
| PATCH /labels/:id | update_label | Renomear, mudar a cor ou transformar um marcador em categoria |
| DELETE /labels/:id | delete_label | Excluir um marcador sem excluir seus e-mails |
| POST /labels/:id/rules | create_label_rule | Adicionar uma regra de arquivamento automático a um marcador |
| DELETE /labels/:id/rules/:rule_id | delete_label_rule | Excluir uma regra de arquivamento automático |
| POST /drafts | create_draft | Criar um rascunho do compositor |
| GET /drafts | list_drafts | Listar rascunhos do compositor |
| GET /drafts/:id | get_draft | Recuperar um rascunho e seus anexos |
| PUT /drafts/:id | update_draft | Substituir o conteúdo do rascunho |
| DELETE /drafts/:id | delete_draft | Descartar um rascunho |
| POST /drafts/:id/attachments | upload_attachment | Fazer upload de um anexo para um rascunho |
| GET /attachments/:id | download_attachment | Baixar um anexo privado |
| DELETE /attachments/:id | delete_attachment | Excluir um anexo privado |
| GET /sending-identities | list_sending_identities | Listar identidades de remetente verificadas |
| GET /templates | list_templates | Listar templates hospedados |
| POST /templates | create_template | Criar um template hospedado |
| GET /templates/:id | get_template | Recuperar rascunhos, releases e uso |
| PUT /templates/:id/draft | update_template_draft | Salvar automaticamente um rascunho de template |
| POST /templates/:id/draft | create_template_draft | Criar um novo rascunho a partir da release publicada |
| POST /templates/:id/render | render_template | Renderizar a saída exata do servidor |
| POST /templates/:id/test | send_template_test | Enviar um snapshot de teste |
| POST /templates/:id/publish | publish_template | Publicar uma release imutável de template |
| POST /templates/:id/archive | archive_template | Arquivar um template |
| POST /templates/:id/restore | restore_template | Restaurar um template arquivado |
| POST /domains | add_domain | Adicionar um domínio de envio |
| GET /domains | list_domains | Listar domínios e o estado de DNS em cache |
| GET /domains/:id | get_domain | Recuperar os detalhes de configuração de um domínio |
| POST /domains/:id/verify | verify_domain | Refresh domain and DNS verification |
| POST /domains/:id/inbound/setup | setup_inbound | Provision inbound receiving |
| POST /domains/:id/inbound/verify | verify_inbound | Verificar o roteamento do MX de entrada |
| DELETE /domains/:id | delete_domain | Excluir um domínio |
| GET /dns/provider | get_dns_provider | Detectar o provedor de DNS autoritativo e os hosts relativos dos registros |
| GET /dns/domain-connect/connect | get_domain_connect_link | Criar um link de consentimento do Domain Connect para configuração de DNS com um clique |
| POST /inboxes | create_inbox | Criar um endereço de entrada |
| GET /inboxes | list_inboxes | Listar endereços de entrada |
| GET /inboxes/:id | get_inbox | Recuperar um endereço de entrada |
| PATCH /inboxes/:id | update_inbox | Renomear, ativar ou desativar uma caixa de entrada |
| PUT /inboxes/:id/forwarding | set_inbox_forwarding | Encaminhar os e-mails recebidos de uma caixa de entrada para outro endereço |
| DELETE /inboxes/:id | delete_inbox | Excluir uma caixa de entrada mantendo as mensagens |
| GET /deliverability/stats | deliverability_stats | Recuperar estatísticas de entrega dos últimos 30 dias |
| GET /deliverability/reputation | list_sender_reputation | Listar o estado de reputação por identidade de remetente exata |
| GET /deliverability/account | deliverability_account | Account delivery rates, daily ladder, and bounce trend |
| GET /deliverability/domains | deliverability_domains | Per-domain sent, delivered, hard and soft bounces, complaints, and failures |
| GET /deliverability/senders | deliverability_senders | Per-From-address delivery rates |
| POST /deliverability/score | score_email | Score an email's content before it is sent |
| GET /emails/:id/delivery | email_delivery | Delivery timeline for one email, with bounce and complaint reasons |
| GET /threads/:id/delivery | thread_delivery | Per-thread delivery counts and per-message failure reasons |
| GET /suppressions | list_suppressions | Listar as supressões do workspace |
| DELETE /suppressions/:email | remove_suppression | Remover uma supressão por bounce elegível |
| GET /blocked-recipients | list_blocked_recipients | Listar bounces, reclamações e descadastros |
| GET /webhooks | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| PATCH /webhooks/:id | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| DELETE /webhooks/:id | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/rotate-secret | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/test | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id/deliveries | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id/deliveries/:deliveryId | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/deliveries/:deliveryId/retry | não exposto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /contacts | list_contacts | List contacts |
| POST /contacts | create_contact | Add a contact with its consent basis |
| PUT /contacts | upsert_contact | Create or update a contact by email |
| POST /contacts/bulk | bulk_update_contacts | Tag, move, unsubscribe, or delete many contacts at once |
| GET /contacts/export | não exposto | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| GET /contacts/:id | get_contact | Retrieve a contact by ID or email |
| PATCH /contacts/:id | update_contact | Update a contact's name, fields, or tags, or unsubscribe it |
| DELETE /contacts/:id | delete_contact | Delete a contact and its list memberships |
| POST /contact-imports | import_contacts | Import contacts from CSV |
| GET /contact-imports | list_contact_imports | List recent contact imports |
| GET /tags | list_tags | List contact tags with how many contacts carry each |
| GET /contact-fields | list_contact_fields | List custom contact field definitions |
| PUT /contact-fields/:key | set_contact_field | Define or change a custom contact field |
| DELETE /contact-fields/:key | delete_contact_field | Delete a custom field definition |
| GET /segments | list_segments | List saved segments with live counts |
| POST /segments | create_segment | Save a segment |
| POST /segments/preview | preview_segment | Count and sample the contacts that match unsaved conditions |
| GET /segments/:id | get_segment | Retrieve a segment and its live count |
| PATCH /segments/:id | update_segment | Rename a segment or change its conditions |
| DELETE /segments/:id | delete_segment | Delete a segment |
| GET /lists | list_lists | List contact lists with member counts |
| POST /lists | create_list | Create a list with an optional signup form, welcome email, and newsletter site |
| GET /lists/:id | get_list | Retrieve a list |
| PATCH /lists/:id | update_list | Rename a list or change its signup form, welcome email, or site |
| DELETE /lists/:id | delete_list | Delete a list without deleting its contacts |
| POST /lists/:id/contacts | add_list_contacts | Add existing contacts to a list |
| DELETE /lists/:id/contacts/:contact_id | remove_list_contact | Remove a contact from a list |
| GET /broadcasts | list_broadcasts | List broadcasts |
| POST /broadcasts | create_broadcast | Create a broadcast draft |
| GET /broadcasts/:id | get_broadcast | Retrieve a broadcast and its delivery totals |
| PATCH /broadcasts/:id | update_broadcast | Edit a draft broadcast |
| DELETE /broadcasts/:id | delete_broadcast | Delete a draft broadcast |
| GET /broadcasts/:id/checks | check_broadcast | Run the pre-send checks for a broadcast |
| POST /broadcasts/:id/test | send_broadcast_test | Send a test copy of a draft |
| POST /broadcasts/:id/schedule | schedule_broadcast | Schedule a draft to send later |
| POST /broadcasts/:id/unschedule | unschedule_broadcast | Unschedule a draft |
| POST /broadcasts/:id/duplicate | duplicate_broadcast | Copy a broadcast into a new draft |
| POST /broadcasts/:id/send | send_broadcast | Send a broadcast to its audience |
| POST /broadcasts/:id/send-more | send_broadcast_to_more | Send a sent broadcast to more of its audience |
| POST /broadcasts/:id/cancel | cancel_broadcast | Cancel a draft or sending broadcast |
| GET /broadcasts/:id/recipients | list_broadcast_recipients | List a broadcast's recipients, outcomes, and engagement |
| GET /broadcasts/:id/report | get_broadcast_report | Retrieve a broadcast's engagement report |
| GET /campaigns/overview | get_campaign_overview | Retrieve subscriber growth and recent broadcast performance |
| GET /newsletter-settings | get_newsletter_settings | Retrieve newsletter settings |
| PATCH /newsletter-settings | update_newsletter_settings | Change newsletter settings |
| POST /uploads/images | não exposto | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| GET /uploads/images | list_uploaded_images | List recently uploaded images |
| POST /events | track_event | Record something a contact did |
| POST /events/batch | não exposto | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| GET /automations | list_automations | List automations with their 30-day totals |
| POST /automations | create_automation | Create an automation as a draft |
| GET /automations/:key | get_automation | Retrieve an automation with its emails |
| PATCH /automations/:key | update_automation | Edit an automation |
| DELETE /automations/:key | delete_automation | Delete an automation and its history |
| PUT /automations/:key/steps/:position | set_automation_step | Create or change one email of an automation |
| DELETE /automations/:key/steps/:position | delete_automation_step | Remove one email from an automation |
| PUT /automations/:key/steps/:position/variants/:locale | set_automation_step_variant | Create or change a language version of an email |
| POST /automations/:key/steps/:position/test | send_automation_test_email | Send one email of an automation to yourself as a test |
| POST /automations/:key/test | send_automation_test | Send every email of an automation to yourself as tests |
| POST /automations/:key/status | set_automation_status | Turn an automation on or off |
| POST /automations/:key/enroll | enroll_contact | Add a contact to an automation |
| POST /automations/:key/exit | exit_contact | Take a contact out of an automation |
| GET /automations/:key/preview | preview_automation | Dry run: what each person in an automation would get now |
| GET /automations/overview | get_automations_overview | Totals and a daily series across every automation |
| GET /automations/:key/report | get_automation_report | Results of one automation, with one row per email |
| GET /automations/:key/people | list_automation_people | List the people in an automation by what they did |
| GET /automations/:key/people/:contact_id | get_automation_person | One person's history in an automation |
| POST /automations/:key/import-history | não exposto | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| GET /automation-settings | get_sending_limits | Retrieve the workspace's sending limits for automations |
| PUT /automation-settings | update_sending_limits | Change the workspace's sending limits for automations |
| GET /automation-library | list_automation_templates | List the template library: ready-made lifecycle emails |
| GET /automation-library/:id | get_automation_template | Read one template or set, with the email as it will look |
| POST /automation-library/:id/use | use_automation_template | Create a draft automation from a template or set |
| GET /events | list_events | List what contacts did, newest first |
| GET /events/names | list_event_names | List the kinds of event recorded in the last 30 days |
| POST /events/preview | não exposto | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
| GET /connections | list_connections | List the workspace's connections (incoming webhooks) |
| POST /connections | create_connection | Create a connection and get its address |
| POST /connections/test | não exposto | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
| GET /connections/:id | get_connection | Retrieve a connection with its last deliveries |
| PATCH /connections/:id | update_connection | Change a connection or switch it on or off |
| DELETE /connections/:id | delete_connection | Delete a connection |
| POST /connections/:id/address | não exposto | The address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings. |
| GET /account | get_account | Recuperar conta, uso, estado de cobrança e contagens do workspace com uma chave de API |
| GET /account/diagnostics | get_account_diagnostics | Diagnose sending and receiving problems in the workspace |
| GET /analytics | get_analytics | Recuperar as análises de envio do painel para 7, 30 ou 90 dias |
| GET /profile | get_account | Equivalente de GET /account apenas para sessão; o servidor MCP lê a rota da chave de API. |
| POST /billing/checkout | não exposto | As 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/cancel | não exposto | As 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 /keys | não exposto | Excluída deliberadamente: um agente não deve emitir nem destruir credenciais. As chaves são gerenciadas por uma pessoa no painel. |
| GET /keys | list_api_keys | Listar metadados de chaves de API |
| DELETE /keys/:id | não exposto | Excluída deliberadamente: um agente não deve emitir nem destruir credenciais. As chaves são gerenciadas por uma pessoa no painel. |
Deliberadamente indisponível
| Recurso | Endpoints | Motivo |
|---|---|---|
| Criar, rotacionar, revogar ou excluir chaves de API | POST /keys, DELETE /keys/:id | Excluí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 assinatura | POST /billing/checkout, POST /billing/cancel | As 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/connect | Exige 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 suporte | POST /api/contact | Formulário público do site de marketing, para pessoas, não uma operação do workspace. |
| Webhook endpoints and deliveries | GET /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/retry | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| Upload editor images and export contacts as CSV | POST /uploads/images, GET /contacts/export | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| Import an automation's send history and record events in bulk | POST /automations/:key/import-history, POST /events/batch | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| Move SendHQ's own win-back emails onto automations (backfill and comparison) | POST /automations/platform-backfill, GET /automations/platform-compare | Internal 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 address | POST /connections/:id/address | The address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings. |
| Dry runs for a sample payload and for a set of events | POST /connections/test, POST /events/preview | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
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.