Para agentes de IA

Servidor MCP de SendHQ

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

142 toolsstdio transport, one command0 key-management tools
Instalar y conectar (Claude Code)
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp

Qué es 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.

Es un servidor stdio local integrado en el binario de la CLI sendhq. Su cliente MCP inicia sendhq mcp como proceso hijo y se comunica mediante JSON-RPC por stdin/stdout. Cada llamada a una herramienta se convierte en una solicitud documentada a la API REST de SendHQ en https://sendhq.cc/api/v1, autenticada con la clave de API de su espacio de trabajo, de modo que el servidor MCP tiene exactamente los permisos de esa clave y ninguno más.

  • 142 tools in 10 groups, generated from one catalog that is also published as tools.json.
  • JSON Schemas estrictos: los argumentos desconocidos, los tipos incorrectos y los campos obligatorios ausentes se rechazan localmente antes de que nada llegue a SendHQ.
  • Errores estructurados con un code estable, el status HTTP, una explanation, un remedy concreto y la indicación de si reintentar puede ayudar.
  • Toda herramienta que envía correo real o destruye datos lo indica en las primeras palabras de su descripción y lleva anotaciones de seguridad de MCP.
  • El modo --read-only oculta todas las herramientas que envían o modifican datos.
  • No se registra nada. stdout transporta solo mensajes del protocolo; la clave de API y el contenido de los mensajes nunca llegan a un log.
No es el endpoint MCP de documentación.SendHQ también aloja un pequeño endpoint MCP de documentación, de solo lectura, en https://sendhq.cc/api/mcp (consulta de precios y documentación, sin acceso a la cuenta). El servidor de esta página es el completo, con alcance de cuenta; se ejecuta localmente o como el conector alojado que se describe a continuación.

Use SendHQ in Claude, ChatGPT and Grok

Sin instalación: SendHQ también ejecuta este servidor como conector alojado en https://mcp.sendhq.cc/mcp, con las mismas herramientas. Usted inicia sesión con su cuenta de SendHQ en lugar de pegar una clave.

Claude

  1. Abra Settings → Connectors y busque SendHQ en el directorio, o elija Add custom connector y pegue https://mcp.sendhq.cc/mcp.
  2. Haga clic en Connect, inicie sesión en SendHQ, revise el acceso y haga clic en Allow.
  3. Pídale a Claude que revise su bandeja de entrada, que envíe un correo desde su dominio verificado o que le explique un rebote.

ChatGPT

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

Grok

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

Muse by Meta

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

Aprobación y desconexión

  • The request_feature tool sends a feature request to the SendHQ team with your account details, so we can follow up by email.
  • Las herramientas que envían correo real o eliminan datos están etiquetadas como tales. Si el asistente le pregunta primero o no se configura por herramienta en el propio asistente: en Claude, elija Needs approval para esas herramientas en Settings → Connectors → SendHQ.
  • El conector obtiene su propia clave de API, con el nombre del asistente (por ejemplo, “Claude (AI connector)”). Elimínela en API Keys para desconectarlo de inmediato.
  • No puede crear ni revocar claves de API ni modificar la facturación. Los adjuntos se envían y se devuelven en base64; no hay acceso a archivos locales.
  • Sending requires an active subscription. There is no free allowance, including mail to the account owner.

Preguntas: postmaster@sendhq.cc. Privacidad: sendhq.cc/privacy.

Instalación

Instale el binario sendhq (Linux, macOS y Windows en x86-64 y arm64). El instalador verifica el checksum de la versión y coloca el binario en ~/.local/bin de forma predeterminada.

macOS y Linux
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
Windows PowerShell
irm https://downloads.sendhq.cc/install.ps1 | iex
Comprobar la instalación
sendhq version
SENDHQ_API_KEY=re_your_key sendhq doctor

Cree una clave de API en el panel, en https://sendhq.cc/app#/keys. El servidor MCP no puede crear claves. El único comando que ejecuta el servidor es:

Ejecutar el servidor stdio
SENDHQ_API_KEY=re_your_key sendhq mcp

Normalmente nunca lo ejecuta a mano: lo inicia el cliente MCP. Si se ejecuta en una terminal, espera JSON-RPC por stdin.

Configurar su cliente

Claude Code

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

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

Agregue --scope user para que esté disponible en todos los proyectos, o --scope project para escribirlo en el .mcp.json del proyecto. En un .mcp.json compartido, haga referencia a la clave desde el entorno en lugar de confirmarla en el repositorio; Claude Code expande ${VAR} en .mcp.json.

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

OpenAI Codex

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

O desde la línea de comandos: 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\) y reinicie la aplicación. Las aplicaciones de escritorio no heredan el PATH de su shell, así que use la ruta absoluta del binario (which sendhq).

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

Cualquier otro cliente MCP

Configure un servidor stdio con el comando sendhq, los argumentos ["mcp"] (opcionalmente "--read-only") y las variables de entorno que se indican a continuación. El servidor admite las versiones del protocolo MCP 2024-11-05, 2025-03-26, 2025-06-18 y 2025-11-25, e implementa initialize, ping, tools/list y tools/call. Los resultados de las herramientas incluyen tanto un bloque de texto JSON como structuredContent.

Prueba rápida de stdio sin cliente (canalizar a sendhq mcp)
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"probe","version":"1"}}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_service_health","arguments":{}}}

No existe un transporte HTTP alojado para el servidor con alcance de cuenta. Un endpoint MCP remoto con capacidad de escritura necesitaría OAuth por usuario, que SendHQ no ofrece; el binario local mantiene la clave en la máquina que ya la tiene.

Entorno y flags

Variable o flagObligatoriaSignificado
SENDHQ_API_KEYsíClave de API del espacio de trabajo (re_…). Todas las herramientas excepto get_service_health la necesitan. Sin ella, el servidor arranca igualmente y cada llamada devuelve un auth_error estructurado que explica cómo solucionarlo.
SENDHQ_API_BASE_URLnoURL base de la API. Valor predeterminado: https://sendhq.cc/api/v1. Úsela solo para un despliegue local o de staging. SENDHQ_BASE_URL se acepta como alias antiguo.
SENDHQ_MCP_READ_ONLYno1, true o yes se comporta como --read-only.
--read-onlynoExpone solo las herramientas que no envían correo ni cambian el estado. Las herramientas ocultas también se rechazan si se llaman por su nombre.
SENDHQ_PROFILE / --profilenoUsa una clave guardada por sendhq auth login en el llavero del sistema operativo en lugar de SENDHQ_API_KEY. Si existen ambas, prevalece la variable de entorno.

La clave se envía únicamente como encabezado Authorization: Bearer a la URL base configurada. Nunca se imprime, se registra, se repite en los errores ni se incluye en los resultados de las herramientas.

Modelo de seguridad para agentes

  • Sends real email. send_email, send_batch, send_template_test, send_broadcast, send_broadcast_test, schedule_broadcast (at the scheduled time), and send_broadcast_to_more deliver mail to real people and consume delivery credits. Their descriptions start with SENDS REAL EMAIL. Call them only when the user explicitly asked for that specific message to be sent, with the recipients, sender, and content confirmed.
  • Destructive. delete_email, delete_draft, delete_attachment, delete_domain, delete_inbox, remove_suppression, the campaign deletes (delete_contact, delete_list, remove_list_contact, delete_broadcast, cancel_broadcast, delete_segment, delete_contact_field), and bulk_update_contacts are marked destructiveHint: true and their descriptions start with DESTRUCTIVE. Confirm with the user first. remove_suppression weakens a safety block and is appropriate only when a human confirms the address works again.
  • Cambian el estado. Crear o actualizar borradores, plantillas, dominios y bandejas de entrada, publicar plantillas e iniciar la verificación modifican el espacio de trabajo, pero no envían correo.
  • Solo lectura. Todo lo demás es readOnlyHint: true y se puede llamar libremente.
  • Este servidor nunca modifica el DNS. add_domain devuelve registros para que una persona los publique; get_domain_connect_link devuelve una URL de consentimiento que una persona debe abrir y aprobar en su proveedor de DNS.
  • Este servidor nunca modifica la facturación. get_account solo lee el plan, el uso y el estado de la suscripción.
  • Sending requires an active subscription. There is no free allowance. Every send, including a test and a send to the account owner's own address, returns subscription_required (402) until a plan is active. Lapsed, cancelled, and past-due subscriptions are refused the same way. The owner chooses a plan in the dashboard (Profile & Billing) or at https://sendhq.cc/pricing. Unpaid workspaces can still verify domains, create keys, and read the workspace.
  • Accepted is not delivered. A successful send returns an ID; delivery, bounce, and complaint evidence arrives later in list_email_events. Never claim inbox placement or that a person read a message. Broadcast opens are estimates: privacy proxies and security scanners load images on their own, and requests that look automated are counted apart (machine in get_broadcast_report).
  • No cambie a otra dirección From para eludir una pausa 423, y nunca vuelva a agregar destinatarios que se hayan dado de baja o que hayan presentado una queja.

Las claves de API quedan fuera del alcance

Por diseño, no hay herramientas que creen, modifiquen, roten, revoquen o eliminen claves de API. Un agente no debe emitir ni destruir credenciales. list_api_keys devuelve solo nombres, prefijos no secretos y fechas de último uso. La gestión de claves se hace en el panel, con una persona que haya iniciado sesión.

Flujos de trabajo

1. Primer envío

  1. get_service_health confirma que la API es accesible (funciona sin clave).
  2. get_account shows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returns subscription_required.
  3. list_sending_identities enumera las direcciones From que puede usar. Si está vacía, complete primero el flujo de dominio.
  4. Confirme con el usuario el remitente, el destinatario, el asunto y el cuerpo; después llame a send_email con una idempotency_key.
  5. list_email_events con el id devuelto muestra delivery, bounce, complaint o reject en cuanto el proveedor lo notifica (normalmente entre unos segundos y unos minutos).
Primer envío
{
  "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. Verificación de dominios de principio a fin

  1. add_domain with name: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).
  2. get_dns_provider con el domain_id detecta el proveedor de DNS autoritativo y devuelve el host relativo exacto que hay que introducir para cada registro en ese proveedor.
  3. If providers.domainConnect.available is true, get_domain_connect_link returns a consent URL. Give it to the human; nothing changes until they approve at the provider. Otherwise, give the human the records to publish. Never publish a second SPF record: merge SendHQ's SPF include (include:amazonses.com) into the existing v=spf1 value.
  4. verify_domain rechecks DNS and DKIM verification. Status moves through pending, checking, and propagating to verified. Poll verify_domain or get_domain every 30–60 seconds; DNS can take minutes to hours.
  5. Cuando status es verified, las direcciones del dominio aparecen en list_sending_identities.

3. Rebotes, quejas y supresiones

  1. list_blocked_recipients devuelve todas las direcciones bloqueadas con su motivo (bounce, complaint, unsubscribe) y un recuento resumido.
  2. list_suppressions devuelve las supresiones por rebote permanente y por queja; deliverability_stats ofrece las tasas de entrega, rebotes y quejas de 30 días; list_sender_reputation muestra qué direcciones From tienen el envío limitado o en pausa.
  3. Un envío que contiene un destinatario suprimido falla con 422 recipient_suppressed. Quite ese destinatario y vuelva a enviar.
  4. Llame a remove_suppression solo cuando una persona confirme que un buzón que rebotaba ahora funciona. Las supresiones por queja son permanentes (409 complaint_suppression_locked).

4. Recibir correo entrante

  1. El dominio (a menudo un subdominio como inbound.example.com) debe estar verificado.
  2. setup_inbound habilita la recepción y devuelve un registro MX. Una persona lo publica.
  3. verify_inbound hasta que status sea ready.
  4. create_inbox con domain_id y local_part (por ejemplo, support) crea support@inbound.example.com.
  5. Consulte periódicamente list_emails con direction: "in" y unread: true (opcionalmente inbox_id). Lea un mensaje con get_email, su conversación con get_thread y los adjuntos con download_attachment, y márquelo como atendido con mark_email (read: true).
  6. Responda dentro del hilo con send_email y reply_to_email_id; SendHQ establece In-Reply-To, References y el hilo.

5. Webhooks y notificaciones 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 un fallo de entrega

  1. Localice el mensaje: list_emails con direction: "out" y to o query, o get_email si tiene el ID. status: failed significa que SendHQ o el proveedor lo rechazó en el envío; el error del correo explica el motivo.
  2. list_email_events: bounce (permanente o transitorio, con el diagnóstico del proveedor), complaint, reject o delivery. Si aún no hay eventos, el proveedor no ha informado; espere y vuelva a comprobar.
  3. If the send call itself failed, read the error code: subscription_required → the owner activates a plan; sender_domain_unverified → finish domain verification; recipient_suppressed → the address hard-bounced or complained before; sender_paused → inspect list_sender_reputation; account_paused → the workspace is paused for review, read the rates; daily_limit_reached → wait until midnight UTC; quota_exhausted → get_account usage.
  4. get_domain comprueba que DKIM, SPF y DMARC siguen publicados; deliverability_stats muestra si el problema es de un solo mensaje o una tendencia.
  5. Informe lo que muestran las evidencias. Un evento delivery significa que el servidor del destinatario aceptó el mensaje, no que llegó a la bandeja de entrada ni que se leyó.

7. Encargarse de una categoría de tareas (etiquetas)

  1. create_label con name (por ejemplo, Agent/Orders) y skip_inbox: true. Eso convierte la etiqueta en una categoría: el correo recibido que la obtiene se archiva, de modo que aparece solo en la etiqueta y nunca en la bandeja de entrada de la persona.
  2. Envíe el correo de la tarea con send_email (o send_batch) y labels: ["Agent/Orders"]. Las respuestas a esa conversación heredan la etiqueta automáticamente y no pasan por la bandeja de entrada.
  3. Para el correo que empieza fuera de sus conversaciones, agregue una regla de archivado: create_label_rule con inbox_id (una dirección dedicada como orders@…), from, to o subject. Pase apply_to_existing: true para archivar el correo ya recibido.
  4. Trabaje la categoría: list_emails con label: "Agent/Orders", direction: "in" y unread: true; lea con get_email o get_thread, responda con send_email y reply_to_email_id, y use mark_email read: true cuando lo haya atendido.
  5. Mueva un mensaje suelto hacia dentro o fuera con label_email (add / remove). Agregar una etiqueta de categoría a un mensaje recibido también lo archiva.
  6. Opcionalmente, set_inbox_forwarding envía una copia de todo lo que recibe una dirección de recepción a otro buzón (el destino lo confirma primero por correo).
Enviar a una categoría
{
  "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. Adjuntos y plantillas

Adjunte hasta 10 archivos con attachments de send_email (cada uno necesita content_base64 o un file_path local; filename toma por defecto el nombre base del archivo) en un plan de pago. Para las plantillas alojadas: create_template → update_template_draft → render_template para previsualizar con datos de ejemplo → send_template_test (envía una prueba real) → publish_template; después envíe con send_email o send_batch usando template: {key, data} y exactamente un destinatario to.

9. Send a newsletter

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

10. Run an automation

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

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

11. See what came in, and connect another system

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

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

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

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

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

Resultados, paginación y errores

Una llamada correcta devuelve el objeto JSON de la API como structuredContent y como bloque de texto JSON. Toda herramienta list_* acepta limit (1–200, valor predeterminado 50) y offset, y agrega un objeto pagination. Siga llamando con offset: pagination.next_offset mientras has_more sea true.

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

Una llamada fallida devuelve isError: true con un error estructurado. Siga el remedy en lugar de reintentar a ciegas; reintente solo cuando retryable sea true.

Error estructurado de herramienta
{
  "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 error opcionales: request_id (indíquelo al soporte), retry_after_seconds, problems (lista de infracciones del esquema para invalid_arguments) e idempotent_replayed (consulte Idempotencia).

Idempotencia

send_email y send_batch aceptan idempotency_key (máximo 200 caracteres), que se envía como encabezado Idempotency-Key. Genere una clave estable por cada mensaje lógico, por ejemplo invoice-4812-receipt.

  • Un reintento debe reutilizar la misma clave Y un cuerpo de solicitud idéntico. La misma clave con cualquier cambio (destinatario, asunto, cuerpo, encabezado, datos de plantilla, incluso valores de argumentos) devuelve 409 idempotency_conflict.
  • Misma clave, mismo cuerpo y el original ya terminado: SendHQ devuelve el resultado almacenado sin volver a enviar. Así se reintenta de forma segura después de un timeout o de un network_error.
  • Misma clave mientras el original sigue en curso: 409 idempotency_in_progress, que se puede reintentar tras una breve espera.
  • Un mensaje lógico nuevo necesita una clave nueva.
  • Los fallos almacenados también se reproducen. Si el primer intento falló, reintentar con la misma clave devuelve ese mismo fallo con idempotent_replayed: true y retryable: false. Revise list_emails (direction: out) para confirmar que no salió nada, corrija la causa y después envíe con una clave nueva.
  • El servidor nunca reintenta un POST por su cuenta. Solo las llamadas GET de solo lectura se reintentan automáticamente (hasta 3 intentos ante errores de red, 429 y 5xx).
  • send_email con attachments en línea no admite una idempotency_key, porque ejecuta varias solicitudes. Para envíos con adjuntos seguros ante reintentos: create_draft → upload_attachment → send_email con draft_id e idempotency_key.
Envío seguro ante reintentos (repetir exactamente si hay timeout)
{
  "name": "send_email",
  "arguments": {
    "from": "Acme <billing@example.com>",
    "to": [
      "owner@example.com"
    ],
    "subject": "Receipt #4812",
    "text": "Thanks for your payment.",
    "idempotency_key": "receipt-4812"
  }
}

Límites de frecuencia y cuotas

SendHQ no publica un límite fijo de solicitudes por segundo para la API. Los límites con los que realmente se encuentra un agente son límites de uso, que se devuelven como 429:

  • Entregas mensuales a destinatarios por plan. Cada dirección To, Cc y Bcc cuenta como una entrega. Consulte get_account → usage.recipientDeliveries frente a usage.emailQuotaMonth.
  • Destinatarios diarios por dirección From exacta, según el estado de reputación de ese remitente (list_sender_reputation → dailyLimit, 2.000 de forma predeterminada en los planes de pago).
  • Subscription: sending is refused with subscription_required until a paid plan is active. There is no free or trial allowance.
  • Workspace daily ladder on paid plans: 1,000 recipients on day one, then 2,000, 3,000, 5,000, 8,000, 12,000, 18,000, 25,000, 35,000, 45,000, and 50,000. A step is gained after a UTC day that used at least half the cap with healthy 7-day feedback. A high rate demotes once per incident, not every day the rate stays high. See get_account → sendingLimit. Over the cap: daily_limit_reached, not queued, retry after resets_at (midnight UTC), not on a short backoff.
  • Hourly pace: about one tenth of the day's cap each UTC hour (100 on day one). hourly_limit_reached waits until the next UTC hour.
  • New domains: a sending domain less than 30 days old may send at most 500 Gmail recipients a day (gmail_recipient_limit), on any ladder rung. gmail_rate_limited means Gmail returned 4.7.28; wait until resets_at and keep sending to other providers.
  • Adjuntos: como máximo 10 archivos y 10 MB por mensaje; 10 GB al mes de transferencia de adjuntos ponderada por destinatario en los planes de pago.
  • Por solicitud: To + Cc + Bcc hasta 100 direcciones; send_batch hasta 100 mensajes.
  • Cortacircuitos de reputación: en una ventana móvil de 7 días, los rebotes o las quejas por encima del umbral limitan o pausan una dirección From (423 sender_paused). Se recupera automáticamente cuando las tasas bajan.

quota_exhausted no se puede reintentar hasta que se reinicie el periodo o cambie el plan. rate_limited se puede reintentar después de retry_after_seconds; en los envíos, reintente con la misma idempotency_key y un cuerpo idéntico.

Catálogo de errores

code es estable; ramifique su lógica en función de él y no de message.

codeHTTP¿Reintentar?Qué significa y qué hacer
invalid_arguments—noLos argumentos no superaron localmente el JSON Schema de la herramienta; nada llegó a SendHQ. Corrija los campos indicados en problems.
auth_error401noClave de API ausente, revocada o incorrecta. Defina SENDHQ_API_KEY para el proceso del servidor; las claves las crea una persona en el panel.
subscription_required402noNo active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then.
payment_required402noLa función requiere un plan de pago (por ejemplo, los adjuntos). Envíe sin ella o cambie a un plan superior.
sender_domain_not_owned403noEl dominio From no pertenece a este espacio de trabajo. Use list_sending_identities o add_domain.
sender_domain_unverified403noEl dominio From aún no está verificado. get_domain, publique los registros que faltan, verify_domain.
domain_limit_reached403noSe alcanzó el límite de dominios del plan. Elimine un dominio sin uso (con aprobación) o cambie a un plan superior.
marketing_not_enabled403noLa clase marketing no está habilitada para este dominio o plan. Use transactional solo si el mensaje realmente lo es.
forbidden403noLa política no permite la operación. Ajuste la solicitud.
not_found404noEl ID no pertenece a este espacio de trabajo. Liste el recurso para encontrar el ID correcto; restaure primero las plantillas archivadas.
idempotency_conflict409noClave reutilizada con un cuerpo distinto. Reenvíe exactamente el original o use una clave nueva para un mensaje nuevo.
idempotency_in_progress409síLa solicitud original sigue en curso. Espere y reintente con la misma clave y el mismo cuerpo.
revision_conflict409noEl borrador de la plantilla cambió desde que lo leyó. get_template, combine los cambios y vuelva a guardar.
complaint_suppression_locked409noEl destinatario presentó una queja. No vuelva a escribirle nunca.
inbound_not_ready409noLa recepción de correo entrante no está lista. setup_inbound, publique el MX, verify_inbound.
conflict409noEl recurso ya existe o está en un estado incorrecto. Léalo y ajústelo.
attachments_too_large413noMás de 10 archivos o 10 MB. Quite adjuntos o reduzca su tamaño.
recipient_suppressed422noUn destinatario tuvo antes un rebote permanente o presentó una queja. Quítelo; consulte list_blocked_recipients.
recipient_unsubscribed422noUn destinatario se dio de baja del correo de marketing. Quítelo de forma permanente.
validation_failed422noContenido rechazado, por ejemplo datos de plantilla que incumplen el contrato de variables. Corrija la entrada.
sender_paused423noEsta dirección From está en pausa por el cortacircuitos de rebotes/quejas de 7 días. Deténgase, corrija la lista y espere la recuperación automática.
account_paused423noWorkspace 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_exhausted429noMonthly allowance, per-sender daily limit, or attachment transfer. Not the workspace daily ladder. Check get_account; wait for that limit to reset or upgrade.
daily_limit_reached429after resetWorkspace daily ladder. Not a short backoff. Wait until resets_at (midnight UTC). The message was not queued.
hourly_limit_reached429after resetHourly pace (about a tenth of the day's cap). Wait until the next UTC hour. Not a short backoff.
gmail_recipient_limit429after reset500 Gmail recipients a day for a sending domain under 30 days old, on any ladder rung. Wait until midnight UTC. Not queued.
gmail_rate_limited429after resetGmail returned 4.7.28 for this domain. Wait until resets_at. Other providers keep sending.
rate_limited429síSlow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap.
server_error5xxsíFallo temporal de SendHQ o del proveedor. Aplique backoff y reintente; los envíos, con la misma clave y el mismo cuerpo. Si idempotent_replayed es true, use una clave nueva después de confirmar que no se envió nada.
network_error—síSe perdió la solicitud o la respuesta. Reintente; en los envíos, la misma idempotency_key lo hace seguro.
invalid_request400noSolicitud mal formada. Lea message y corríjala.
tool_error—noFallo local dentro del servidor MCP (por ejemplo, un file_path ilegible). Lea message.

Referencia de herramientas

Cada herramienta con su clase de seguridad, el endpoint REST al que llama, sus parámetros, la estructura de respuesta y un objeto params de tools/call de ejemplo. Los parámetros son exactos: el servidor rechaza todo lo que no esté en la lista.

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

Correos e hilos

Envía correo realsend_email
POST /emails

Enviar un correo

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.

Proporcione al menos uno de: html, text, template.

ParámetroTipoObligatoriaDescripción
fromstringsíRemitente, p. ej. Acme <hello@example.com>. El dominio debe estar verificado en este espacio de trabajo (consulte list_sending_identities). (máx. 998 caracteres)
tostring[]síDestinatarios. Cada entrada es una dirección, opcionalmente con un nombre visible. To+cc+bcc pueden sumar como máximo 100; cada destino consume un crédito de entrega. (1–100 elementos)
ccstring[]noDestinatarios en copia. (0–100 elementos)
bccstring[]noDestinatarios en copia oculta. (0–100 elementos)
subjectstringnoLínea de asunto. Omítala al enviar una plantilla. (máx. 998 caracteres)
textstringnoCuerpo en texto sin formato. Proporcione text, html o template.
htmlstringnoCuerpo HTML. SendHQ lo sanea y genera el texto cuando se omite text.
reply_tostringnoDirección Reply-To.
headersobjectnoEncabezados personalizados adicionales y seguros (valores string), p. ej. {"X-Entity-Ref-ID": "123"}. Los encabezados de enrutamiento como From/To/Message-ID los controla SendHQ.
message_classstringnotransactional (predeterminado) o marketing. Marketing requiere un plan o dominio con marketing habilitado y agrega la gestión de bajas. (uno de transactional, marketing)
reply_to_email_idstringnoResponder dentro de una conversación existente: el ID em_… del mensaje al que se responde. SendHQ establece In-Reply-To/References y el hilo.
thread_idstringnoID de hilo explícito en el que archivar el mensaje.
draft_idstringnoEnviar con este mensaje los adjuntos de un borrador guardado (dr_…). El borrador se elimina tras un envío correcto.
templateobjectnoEnviar una plantilla alojada publicada en lugar de html/text sin procesar. Requiere exactamente un destinatario to y ningún cc/bcc; la plantilla proporciona el asunto. Proporcione al menos uno de: id, key.
template.idstringnoID de la plantilla (tmpl_…). Proporcione id o key.
template.keystringnoClave de la plantilla, como account-welcome. Proporcione id o key.
template.version_idstringnoID de versión publicada opcional (tmplv_…). Por defecto, la versión publicada actual.
template.dataobjectnoValores para las variables tipadas de la plantilla.
labelsstring[]noNombres de etiqueta o IDs lbl_… en los que archivar este mensaje. Los nombres desconocidos se crean. Las respuestas de la conversación heredan las etiquetas, y una etiqueta de categoría (skip_inbox) mantiene esas respuestas fuera de la bandeja de entrada. Máx. 10. (0–10 elementos)
idempotency_keystringnoEncabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres)
attachmentsobject[]noArchivos que adjuntar (máx. 10 archivos, 10 MB en total). Cada uno necesita content_base64 (más filename) o un file_path local. (0–10 elementos) Proporcione al menos uno de: content_base64, file_path.
attachments[].filenamestringnoNombre de archivo que ve el destinatario. Obligatorio con content_base64; por defecto, el nombre base de file_path. (máx. 255 caracteres)
attachments[].content_typestringnoTipo MIME, p. ej. application/pdf. Por defecto, application/octet-stream.
attachments[].content_base64stringnoContenido del archivo en base64 estándar.
attachments[].file_pathstringnoRuta absoluta de un archivo local que el proceso del servidor MCP pueda leer.
Devuelve{id: em_…, providerMessageId, threadId, templateId, templateVersionId, isTest}. Aceptado no significa entregado: haga el seguimiento con list_email_events.
Ejemplo de params de tools/call
{
  "name": "send_email",
  "arguments": {
    "from": "Acme <hello@example.com>",
    "to": [
      "owner@example.com"
    ],
    "subject": "Your export is ready",
    "text": "Download it from your dashboard.",
    "idempotency_key": "export-ready-42"
  }
}
Envía correo realsend_batch
POST /emails/batch

Enviar un lote de correos personalizados

SENDS REAL EMAIL. Envía de 1 a 100 mensajes independientes en una sola solicitud (úselo para personalizar plantillas por destinatario). Cada elemento tiene la misma estructura que send_email (sin attachments/idempotency_key). Cada elemento tiene éxito o falla por separado: HTTP 207 significa éxito parcial; revise cada data[i].ok y data[i].error. Una sola idempotency_key cubre todo el cuerpo del lote.

ParámetroTipoObligatoriaDescripción
emailsobject[]síMensajes que enviar. (1–100 elementos) Proporcione al menos uno de: html, text, template.
idempotency_keystringnoIdempotency-Key para todo el lote (máx. 200 caracteres). (máx. 200 caracteres)
Devuelve{data: [{index, ok, id?, error?: {message, status}}], count, successful, failed}.
Ejemplo de params de tools/call
{
  "name": "send_batch",
  "arguments": {
    "emails": [
      {
        "from": "Acme <hello@example.com>",
        "to": [
          "owner@example.com"
        ],
        "template": {
          "key": "account-welcome",
          "data": {
            "first_name": "Asha"
          }
        }
      }
    ],
    "idempotency_key": "welcome-batch-2026-09-26"
  }
}
Solo lecturalist_emails
GET /emails

Listar y buscar correo

Lista el correo enviado (direction: out) y recibido (direction: in), del más reciente al más antiguo, con filtros. El correo recibido se clasifica: lea la bandeja de entrada de la persona con direction: in, archived: false, category: primary; priorice con important: true; el spam se oculta salvo que se indique category: spam o include_spam: true. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
directionstringnoin para el recibido, out para el enviado. (uno de in, out)
statusstringnoFiltro de estado, p. ej. queued, sent, delivered, bounced, complained, failed.
domainstringnoSolo los mensajes de este dominio, o de una lista de dominios separados por comas (coincide con cualquiera).
inbox_idstringnoSolo los mensajes recibidos en esta bandeja de entrada (inb_…).
labelstringnoSolo los mensajes con esta etiqueta: un ID de etiqueta lbl_… o el nombre exacto, o una lista separada por comas (coincide con cualquiera). Use list_labels para ver las carpetas.
archivedbooleannofalse = la vista de la bandeja de entrada (correo recibido no archivado), true = solo archivados. Omítalo para todo el correo.
categorystringnoprimary (personas), updates (newsletters, envíos masivos, automatizados) o spam; o una lista separada por comas. El spam se oculta salvo que se solicite.
importantbooleannotrue = solo los mensajes marcados como importantes (respuestas a conversaciones que usted inició y remitentes marcados como importantes).
include_spambooleannoIncluir el spam en los resultados (para búsquedas en todas las carpetas).
fromstringnoLa dirección del remitente contiene este valor.
tostringnoLa dirección del destinatario contiene este valor.
unreadbooleannotrue = solo no leídos, false = solo leídos.
afterstringnoMarca de tiempo ISO-8601; solo los mensajes creados después de ella. (date-time)
beforestringnoMarca de tiempo ISO-8601; solo los mensajes creados antes de ella. (date-time)
querystringnoBúsqueda de texto libre en asuntos, cuerpos, direcciones de remitente/destinatario y nombres de archivos adjuntos. (máx. 200 caracteres)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [resúmenes de correos], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_emails",
  "arguments": {
    "direction": "in",
    "unread": true,
    "limit": 25
  }
}
Solo lecturaget_email
GET /emails/:email_id

Obtener un correo

Recupera un mensaje con sus encabezados, cuerpo html/text, estado, metadatos del hilo y metadatos de los adjuntos (descargue los bytes con download_attachment).

ParámetroTipoObligatoriaDescripción
email_idstringsíID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
DevuelveObjeto de correo: {id, direction, status, from, to, cc, bcc, subject, html, text, threadId, messageId, providerMessageId, readAt, createdAt, attachments: [{id, filename, contentType, sizeBytes, available}]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Cambia el estadomark_email
PATCH /emails/:email_id

Marcar como leído, archivado, spam o importante

Actualiza un mensaje: read, archived, category (primary, updates, spam; solo correo recibido) e important. Marcar como spam o como importante enseña a SendHQ sobre ese remitente para el correo futuro; pase learn: false para cambiar solo este mensaje. Pase al menos un campo.

ParámetroTipoObligatoriaDescripción
email_idstringsíID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
readbooleannotrue = leído, false = no leído.
archivedbooleannotrue = archivar (fuera de la bandeja de entrada), false = devolver a la bandeja de entrada.
categorystringnoMueve un mensaje recibido a primary, updates o spam. (uno de primary, updates, spam)
importantbooleannoMarca o desmarca el mensaje como importante.
learnbooleannofalse = no recordar este veredicto para el remitente (predeterminado true).
DevuelveEl objeto de correo actualizado.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "mark_email",
  "arguments": {
    "email_id": "em_123",
    "read": true
  }
}
Destructivadelete_email
DELETE /emails/:email_id

Eliminar un correo

DESTRUCTIVE: elimina de forma permanente de SendHQ un mensaje conservado y sus adjuntos almacenados. No recupera un mensaje que ya se entregó.

ParámetroTipoObligatoriaDescripción
email_idstringsíID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Solo lecturalist_email_events
GET /emails/:email_id/events

Listar los eventos de entrega de un correo

Eventos del proveedor para un mensaje enviado: delivery, bounce, complaint, reject, open, click. Es la evidencia de si un mensaje se entregó o de por qué falló. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
email_idstringsíID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{event_type, recipient, reason, created_at, …}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_email_events",
  "arguments": {
    "email_id": "em_123"
  }
}
Solo lecturaget_thread
GET /threads/:thread_id

Obtener una conversación

Recupera todos los mensajes de una conversación en orden cronológico (enviados y recibidos), cada uno con los metadatos de sus adjuntos.

ParámetroTipoObligatoriaDescripción
thread_idstringsíID del hilo (normalmente el ID em_… del primer mensaje; consulte threadId en cualquier correo). (máx. 128 caracteres)
Devuelve{id, subject, data: [correos]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_thread",
  "arguments": {
    "thread_id": "em_123"
  }
}
Read-onlyemail_delivery
GET /emails/:email_id/delivery

Get an email delivery timeline

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

ParámetroTipoObligatoriaDescripción
email_idstringsí
limitintegerno
offsetintegerno
Returns{emailId, status, timeline, count, limit, offset}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "email_delivery",
  "arguments": {
    "email_id": "em_123"
  }
}
Read-onlythread_delivery
GET /threads/:thread_id/delivery

Get a thread delivery summary

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

ParámetroTipoObligatoriaDescripción
thread_idstringsí
Returns{threadId, delivered, bounced, complained, failed, messages}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "thread_delivery",
  "arguments": {
    "thread_id": "thr_123"
  }
}

Etiquetas y reglas de archivado automático

Solo lecturalist_labels
GET /labels

Listar etiquetas

Lista las etiquetas (carpetas) del espacio de trabajo con los recuentos totales y de no leídos, y sus reglas de archivado automático. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{id, name, color, totalCount, unreadCount, rules: [...]}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_labels",
  "arguments": {}
}
Solo lecturaget_label
GET /labels/:label_id

Obtener una etiqueta

Recupera una etiqueta con sus recuentos y reglas de archivado automático.

ParámetroTipoObligatoriaDescripción
label_idstringsíID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres)
DevuelveObjeto de etiqueta.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_label",
  "arguments": {
    "label_id": "Billing"
  }
}
Cambia el estadocreate_label
POST /labels

Crear una etiqueta

Crea una etiqueta tipo carpeta. Defina skip_inbox: true para convertirla en una categoría propiedad de un agente: envíe con labels: [name] y las respuestas se archivan en la etiqueta y quedan fuera de la bandeja de entrada. Las reglas de archivado automático opcionales archivan el correo nuevo enviado/recibido (todas las condiciones de una regla deben coincidir). Defina apply_to_existing para archivar también el correo conservado.

ParámetroTipoObligatoriaDescripción
namestringsíNombre de la etiqueta, p. ej. Billing o Clients/Acme. Único por espacio de trabajo (sin distinguir mayúsculas y minúsculas). (máx. 64 caracteres)
colorstringnoColor hexadecimal, como #1a73e8. Opcional.
skip_inboxbooleannoModo categoría: el correo recibido que obtiene esta etiqueta (por una regla, por responder a una conversación enviada con esta etiqueta o manualmente) se archiva para que aparezca solo en la etiqueta, no en la bandeja de entrada.
rulesobject[]noReglas de archivado automático opcionales (máx. 20). Cada una necesita al menos uno de inbox_id, from, to, subject. (0–20 elementos)
rules[].directionstringnoSolo el correo in (recibido) u out (enviado). Omítalo para ambos. (uno de in, out)
rules[].inbox_idstringnoSolo el correo recibido en esta bandeja de entrada (inb_…). Archiva cada dirección de recepción en su propia carpeta.
rules[].fromstringnoEl remitente contiene este texto (sin distinguir mayúsculas y minúsculas), p. ej. @stripe.com. (máx. 200 caracteres)
rules[].tostringnoTo/Cc contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres)
rules[].subjectstringnoEl asunto contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres)
rules[].skip_inboxbooleannoArchivar el correo recibido que coincida para que aparezca solo en la carpeta de la etiqueta, no en la bandeja de entrada.
apply_to_existingbooleannoArchivar también el correo ya conservado que coincida con las reglas.
DevuelveLa etiqueta creada con sus reglas.
Ejemplo de params de tools/call
{
  "name": "create_label",
  "arguments": {
    "name": "Agent/Orders",
    "skip_inbox": true,
    "rules": [
      {
        "from": "@stripe.com"
      }
    ]
  }
}
Cambia el estadoupdate_label
PATCH /labels/:label_id

Renombrar, cambiar el color o convertir una etiqueta en categoría

Cambia el nombre de una etiqueta, su color o activa/desactiva el modo categoría (skip_inbox). Al activar el modo categoría se archiva el correo recibido que ya está en la etiqueta.

ParámetroTipoObligatoriaDescripción
label_idstringsíID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres)
namestringnoNombre nuevo. (máx. 64 caracteres)
colorstringnoColor hexadecimal nuevo.
skip_inboxbooleannoModo categoría: el correo recibido que obtiene esta etiqueta (por una regla, por responder a una conversación enviada con esta etiqueta o manualmente) se archiva para que aparezca solo en la etiqueta, no en la bandeja de entrada.
DevuelveLa etiqueta actualizada.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_label",
  "arguments": {
    "label_id": "lbl_123",
    "name": "Finance/Billing"
  }
}
Destructivadelete_label
DELETE /labels/:label_id

Eliminar una etiqueta

DESTRUCTIVE: elimina una etiqueta y sus reglas. El correo en sí se conserva; solo pierde esta etiqueta.

ParámetroTipoObligatoriaDescripción
label_idstringsíID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_label",
  "arguments": {
    "label_id": "lbl_123"
  }
}
Cambia el estadocreate_label_rule
POST /labels/:label_id/rules

Agregar una regla de archivado automático

Agrega una regla a una etiqueta para que el correo nuevo que coincida se archive automáticamente. Todas las condiciones que defina deben coincidir. Use inbox_id para dar a una dirección de recepción su propia carpeta; agregue skip_inbox para mantenerla fuera de la bandeja de entrada.

ParámetroTipoObligatoriaDescripción
label_idstringsíID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres)
directionstringnoSolo el correo in (recibido) u out (enviado). Omítalo para ambos. (uno de in, out)
inbox_idstringnoSolo el correo recibido en esta bandeja de entrada (inb_…). Archiva cada dirección de recepción en su propia carpeta.
fromstringnoEl remitente contiene este texto (sin distinguir mayúsculas y minúsculas), p. ej. @stripe.com. (máx. 200 caracteres)
tostringnoTo/Cc contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres)
subjectstringnoEl asunto contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres)
skip_inboxbooleannoArchivar el correo recibido que coincida para que aparezca solo en la carpeta de la etiqueta, no en la bandeja de entrada.
apply_to_existingbooleannoArchivar también el correo ya conservado que coincida.
Devuelve{id: lrule_…, labelId, direction, inboxId, from, to, subject, skipInbox}.
Ejemplo de params de tools/call
{
  "name": "create_label_rule",
  "arguments": {
    "label_id": "Billing",
    "inbox_id": "inb_123",
    "skip_inbox": true
  }
}
Destructivadelete_label_rule
DELETE /labels/:label_id/rules/:rule_id

Eliminar una regla de archivado automático

DESTRUCTIVE: elimina una regla de archivado automático. El correo ya archivado conserva su etiqueta.

ParámetroTipoObligatoriaDescripción
label_idstringsíID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres)
rule_idstringsíID de la regla (empieza por lrule_), obtenido de get_label. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_label_rule",
  "arguments": {
    "label_id": "lbl_123",
    "rule_id": "lrule_123"
  }
}
Cambia el estadolabel_email
POST /emails/:email_id/labels

Agregar o quitar etiquetas de un correo

Mueve un mensaje entre carpetas: agrega o quita etiquetas por nombre o por ID lbl_…. Los nombres desconocidos en add se crean, salvo que create sea false.

ParámetroTipoObligatoriaDescripción
email_idstringsíID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
addstring[]noEtiquetas que agregar. (0–10 elementos)
removestring[]noEtiquetas que quitar. (0–10 elementos)
createbooleannoCrear las etiquetas desconocidas en add (predeterminado true).
DevuelveEl correo actualizado con labels.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "label_email",
  "arguments": {
    "email_id": "em_123",
    "add": [
      "Billing"
    ],
    "remove": [
      "Support"
    ]
  }
}

Borradores, adjuntos e identidades de remitente

Solo lecturalist_sending_identities
GET /sending-identities

Listar las identidades de remitente verificadas

Direcciones y dominios desde los que este espacio de trabajo puede enviar ahora mismo (dominios verificados, su From predeterminado y las direcciones de entrada activas). Llámela antes de send_email para elegir un from válido.

Sin parámetros.

Devuelve{domains: [nombres de dominios verificados], addresses: [direcciones de remitente], localParts: [...]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_sending_identities",
  "arguments": {}
}
Cambia el estadocreate_draft
POST /drafts

Crear un borrador

Crea un borrador del editor. Los borradores contienen adjuntos: cree un borrador, use upload_attachment y después send_email con draft_id. No envía nada.

ParámetroTipoObligatoriaDescripción
fromstringnoDirección del remitente en un dominio verificado (puede estar vacía mientras se redacta).
tostring[]noDestinatarios. (0–100 elementos)
ccstring[]noDestinatarios en copia. (0–100 elementos)
bccstring[]noDestinatarios en copia oculta. (0–100 elementos)
subjectstringnoLínea de asunto. (máx. 998 caracteres)
htmlstringnoCuerpo HTML.
textstringnoCuerpo en texto sin formato.
reply_to_email_idstringnoID del correo al que responde este borrador.
thread_idstringnoID del hilo al que pertenece este borrador.
DevuelveObjeto de borrador {id: dr_…, from, to, cc, bcc, subject, html, text, attachments: []}.
Ejemplo de params de tools/call
{
  "name": "create_draft",
  "arguments": {
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice"
  }
}
Solo lecturalist_drafts
GET /drafts

Listar borradores

Lista los borradores del editor, los actualizados más recientemente primero. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [borradores], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_drafts",
  "arguments": {}
}
Solo lecturaget_draft
GET /drafts/:draft_id

Obtener un borrador

Recupera un borrador con los metadatos de sus adjuntos.

ParámetroTipoObligatoriaDescripción
draft_idstringsíID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
DevuelveObjeto de borrador con attachments.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Cambia el estadoupdate_draft
PUT /drafts/:draft_id

Reemplazar el contenido de un borrador

Reemplaza el contenido y los destinatarios de un borrador. Es un reemplazo completo: los campos que omita se vacían, así que lea primero get_draft y envíe todos los campos que quiera conservar. Los adjuntos no se ven afectados.

ParámetroTipoObligatoriaDescripción
draft_idstringsíID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
fromstringnoDirección del remitente en un dominio verificado (puede estar vacía mientras se redacta).
tostring[]noDestinatarios. (0–100 elementos)
ccstring[]noDestinatarios en copia. (0–100 elementos)
bccstring[]noDestinatarios en copia oculta. (0–100 elementos)
subjectstringnoLínea de asunto. (máx. 998 caracteres)
htmlstringnoCuerpo HTML.
textstringnoCuerpo en texto sin formato.
reply_to_email_idstringnoID del correo al que responde este borrador.
thread_idstringnoID del hilo al que pertenece este borrador.
DevuelveEl objeto de borrador actualizado.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_draft",
  "arguments": {
    "draft_id": "dr_123",
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice (updated)",
    "text": "Attached."
  }
}
Destructivadelete_draft
DELETE /drafts/:draft_id

Descartar un borrador

DESTRUCTIVE: descarta un borrador y elimina de forma permanente sus adjuntos almacenados.

ParámetroTipoObligatoriaDescripción
draft_idstringsíID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Cambia el estadoupload_attachment
POST /drafts/:draft_id/attachments

Subir un adjunto a un borrador

Sube un archivo a un borrador (máx. 10 archivos y 10 MB en total por mensaje). Proporcione content_base64 o un file_path local. Los adjuntos requieren un plan de pago en el momento del envío.

Proporcione al menos uno de: content_base64, file_path.

ParámetroTipoObligatoriaDescripción
draft_idstringsíID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
filenamestringnoNombre de archivo que ve el destinatario. Por defecto, el nombre base de file_path. (máx. 255 caracteres)
content_typestringnoTipo MIME, p. ej. application/pdf. Por defecto, application/octet-stream.
content_base64stringnoContenido del archivo en base64 estándar.
file_pathstringnoRuta absoluta de un archivo local que el proceso del servidor MCP pueda leer.
Devuelve{id: att_…, filename, contentType, sizeBytes, available}.
Ejemplo de params de tools/call
{
  "name": "upload_attachment",
  "arguments": {
    "draft_id": "dr_123",
    "filename": "invoice.pdf",
    "content_type": "application/pdf",
    "file_path": "/tmp/invoice.pdf"
  }
}
Solo lecturadownload_attachment
GET /attachments/:attachment_id

Descargar un adjunto

Descarga un adjunto privado (enviado, recibido o de un borrador). Devuelve el contenido en base64, o escribe el archivo cuando se define save_to_path (se niega a sobrescribir salvo que overwrite sea true).

ParámetroTipoObligatoriaDescripción
attachment_idstringsíID del adjunto (empieza por att_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
save_to_pathstringnoRuta local absoluta opcional en la que escribir el archivo en lugar de devolverlo en base64.
overwritebooleannoPermite reemplazar un archivo existente en save_to_path. Por defecto, false.
Devuelve{attachment_id, filename, content_type, size_bytes, content_base64} o {attachment_id, filename, content_type, size_bytes, saved_to}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "download_attachment",
  "arguments": {
    "attachment_id": "att_123",
    "save_to_path": "/tmp/invoice.pdf"
  }
}
Destructivadelete_attachment
DELETE /attachments/:attachment_id

Eliminar un adjunto

DESTRUCTIVE: elimina de forma permanente un adjunto almacenado (por ejemplo, para quitar un archivo de un borrador antes de enviarlo).

ParámetroTipoObligatoriaDescripción
attachment_idstringsíID del adjunto (empieza por att_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_attachment",
  "arguments": {
    "attachment_id": "att_123"
  }
}

Plantillas alojadas

Solo lecturalist_templates
GET /templates

Listar plantillas alojadas

Lista las plantillas de correo alojadas con su estado de publicación y su uso. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
lifecyclestringnoactive (predeterminado), archived o all. (uno de active, archived, all)
querystringnoBuscar por nombre o clave. (máx. 120 caracteres)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [plantillas], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_templates",
  "arguments": {
    "lifecycle": "active"
  }
}
Cambia el estadocreate_template
POST /templates

Crear una plantilla alojada

Crea una plantilla con un borrador editable, opcionalmente a partir de una plantilla inicial (welcome, reset, receipt o blank). Publíquela antes de enviar por clave.

ParámetroTipoObligatoriaDescripción
namestringsíNombre legible. (máx. 120 caracteres)
keystringnoClave de envío estable: letras minúsculas, números y guiones; empieza por una letra (2–64 caracteres). Si se omite, se deriva del nombre.
starterstringnoContenido inicial. (uno de blank, welcome, reset, receipt)
Devuelve{template, draft, activeVersion, versions, usage}.
Ejemplo de params de tools/call
{
  "name": "create_template",
  "arguments": {
    "name": "Account welcome",
    "key": "account-welcome",
    "starter": "welcome"
  }
}
Solo lecturaget_template
GET /templates/:template_id

Obtener una plantilla

Recupera el borrador actual de una plantilla (con revision), la versión publicada activa, el historial de versiones y el uso. Acepta ID o clave.

ParámetroTipoObligatoriaDescripción
template_idstringsíID de la plantilla (tmpl_…) o clave. (máx. 128 caracteres)
Devuelve{template, draft: {id, revision, subjectTemplate, htmlTemplate, textTemplate, variables, sampleData, …} | null, activeVersion, versions, usage}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Cambia el estadoupdate_template_draft
PUT /templates/:template_id/draft

Guardar el borrador de una plantilla

Guarda el borrador editable de la plantilla con concurrencia optimista: pase la revision actual obtenida de get_template (409 significa que otra persona guardó antes; vuelva a leer y reintente). Es un reemplazo completo del contenido del borrador: los campos omitidos se vacían, así que envíe todos los campos que quiera conservar. Use marcadores {{variable}}.

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
revisionintegersíRevisión actual del borrador, obtenida de get_template. (1–…)
namestringnoNombre de la plantilla. (máx. 120 caracteres)
subject_templatestringnoAsunto con marcadores. (máx. 998 caracteres)
preheader_templatestringnoTexto de vista previa. (máx. 240 caracteres)
html_templatestringnoCuerpo HTML con marcadores.
text_templatestringnoCuerpo en texto sin formato con marcadores.
fromstringnoRemitente predeterminado para los envíos de esta plantilla.
reply_tostringnoReply-To predeterminado.
variablesobject[]noContrato de variables tipadas. Cada elemento: {key (minúsculas/guiones bajos), label, type: text|number|url|boolean, required (predeterminado true), fallback, description}.
variables[].keystringsí
variables[].labelstringno
variables[].typestringno(uno de text, number, url, boolean)
variables[].requiredbooleanno
variables[].fallbackanyno
variables[].descriptionstringno
sample_dataobjectnoValores de ejemplo usados en vistas previas y pruebas.
Devuelve{template, draft: {revision: next}, validation: {valid, findings}}.
Ejemplo de params de tools/call
{
  "name": "update_template_draft",
  "arguments": {
    "template_id": "account-welcome",
    "revision": 3,
    "name": "Account welcome",
    "subject_template": "Welcome, {{first_name}}",
    "text_template": "Hi {{first_name}}",
    "variables": [
      {
        "key": "first_name",
        "type": "text",
        "required": true
      }
    ],
    "sample_data": {
      "first_name": "Asha"
    }
  }
}
Cambia el estadocreate_template_draft
POST /templates/:template_id/draft

Iniciar un borrador nuevo a partir de la versión publicada

Crea un borrador editable nuevo copiado de la versión publicada actual (409 si ya existe un borrador o no hay nada publicado).

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
Devuelve{draft}.
Ejemplo de params de tools/call
{
  "name": "create_template_draft",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Solo lecturarender_template
POST /templates/:template_id/render

Renderizar la vista previa de una plantilla

Renderiza la salida exacta del servidor (asunto, html, texto) para el borrador, la versión publicada o una versión concreta con los datos indicados. No envía nada. Devuelve 422 con findings cuando los datos incumplen el contrato de variables.

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
version_idstringnoID de versión opcional; por defecto, el borrador y, si no hay, la versión publicada.
dataobjectnoValores de las variables; por defecto, los datos de ejemplo de la versión.
Devuelve{subject, html, text, preheader, versionId, versionNumber, isDraft, findings}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "render_template",
  "arguments": {
    "template_id": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}
Envía correo realsend_template_test
POST /templates/:template_id/test

Enviar un correo de prueba de una plantilla

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ámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
tostring[]síDestinatarios de la prueba. (1–100 elementos)
fromstringnoRemitente en un dominio verificado; por defecto, el From de la plantilla.
version_idstringnoID de versión opcional.
dataobjectnoValores de las variables; por defecto, los datos de ejemplo.
Devuelve{id: em_…, providerMessageId, threadId, isTest: true}.
Ejemplo de params de tools/call
{
  "name": "send_template_test",
  "arguments": {
    "template_id": "account-welcome",
    "to": [
      "owner@example.com"
    ]
  }
}
Cambia el estadopublish_template
POST /templates/:template_id/publish

Publicar una versión de plantilla

Publica el borrador actual como una versión inmutable que usará send_email con template.key. Falla con findings 422 si hay errores de validación, o con 409 si rompería el contrato de variables en vigor de una plantilla que ya se usa en producción.

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
Devuelve{template, published}.
Ejemplo de params de tools/call
{
  "name": "publish_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Cambia el estadoarchive_template
POST /templates/:template_id/archive

Archivar una plantilla

Detiene los envíos nuevos que usan esta plantilla (el historial se conserva; se puede revertir con restore_template). Cualquier integración que envíe con esta clave empezará a fallar con 404.

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
Devuelve{template}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "archive_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Cambia el estadorestore_template
POST /templates/:template_id/restore

Restaurar una plantilla archivada

Vuelve a activar una plantilla archivada.

ParámetroTipoObligatoriaDescripción
template_idstringsíID o clave de la plantilla. (máx. 128 caracteres)
Devuelve{template}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "restore_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}

Dominios y DNS

Solo lecturalist_domains
GET /domains

Listar dominios

Lista los dominios de envío con el setup_status agregado (verified | checking | pending), el estado DNS de cada registro y el estado de entrada. Puede ser lento: los dominios no verificados se vuelven a comprobar en tiempo real. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [dominios con registros], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_domains",
  "arguments": {}
}
Solo lecturaget_domain
GET /domains/:domain_id

Obtener los detalles de configuración de un dominio

Recupera un dominio con los registros DNS exactos que hay que publicar (tipo, nombre, valor), el estado en tiempo real de cada registro según dos resolvedores públicos, dns_issues con sus correcciones y el estado de entrada.

ParámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{id, name, status, setup_status, dns_propagating, records: [{type, name, value, verified, dns_state}], dns_issues: [{code, message, …}], inbound_domain, inbound_status}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Cambia el estadoadd_domain
POST /domains

Agregar un dominio de envío

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ámetroTipoObligatoriaDescripción
namestringsíNombre de dominio sin más, p. ej. example.com o mail.example.com. (máx. 253 caracteres)
default_fromstringnoDirección de remitente predeterminada opcional en este dominio.
Devuelve{id: dom_…, name, status: pending, records: [...], ses: {configured}}.
Ejemplo de params de tools/call
{
  "name": "add_domain",
  "arguments": {
    "name": "example.com"
  }
}
Cambia el estadoverify_domain
POST /domains/:domain_id/verify

Verificar un dominio

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ámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{domain, checks: {ses, dkim, dkim_status}, status: verified|pending}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "verify_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Destructivadelete_domain
DELETE /domains/:domain_id

Eliminar un dominio

DESTRUCTIVE: quita el dominio del espacio de trabajo, incluida su ruta de recepción de correo entrante. Los envíos desde él fallan inmediatamente después. No elimina los registros DNS en su proveedor de DNS.

ParámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Solo lecturaget_dns_provider
GET /dns/provider

Detectar el proveedor de DNS y los hosts de los registros

Detecta el proveedor de DNS autoritativo del dominio y devuelve el host relativo que hay que escribir en ese proveedor para cada registro, el registro DMARC recomendado, las indicaciones de MX de entrada y si está disponible la configuración con un clic (Domain Connect).

ParámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{detectionStatus, detected, zone, nameservers, recordHosts: {recordId: host}, inbound, recommendations, authentication, providers: {domainConnect: {available, providerName}}}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_dns_provider",
  "arguments": {
    "domain_id": "dom_123"
  }
}

Correo entrante

Cambia el estadosetup_inbound
POST /domains/:domain_id/inbound/setup

Habilitar la recepción de correo entrante para un dominio

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ámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{domain: dominio de recepción, status: dns_pending|ready, record: {type: MX, name, value}}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "setup_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Cambia el estadoverify_inbound
POST /domains/:domain_id/inbound/verify

Verificar el MX de entrada

Vuelve a comprobar el registro MX de entrada. El estado pasa a ready cuando ambos resolvedores públicos lo ven.

ParámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{domain, status: ready|dns_pending|propagating|checking, record}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "verify_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Solo lecturalist_inboxes
GET /inboxes

Listar direcciones de entrada

Lista las direcciones de recepción, opcionalmente de un solo dominio. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
domain_idstringnoFiltro opcional por ID de dominio.
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{id, address, name, status, domainId}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_inboxes",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Solo lecturaget_inbox
GET /inboxes/:inbox_id

Obtener una bandeja de entrada

Recupera una dirección de entrada.

ParámetroTipoObligatoriaDescripción
inbox_idstringsíID de la bandeja de entrada (empieza por inb_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
DevuelveObjeto de bandeja de entrada.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}
Cambia el estadocreate_inbox
POST /inboxes

Crear una dirección de entrada

Crea una dirección como support@<receiving domain> en un dominio cuyo estado de entrada sea ready (ejecute antes setup_inbound y verify_inbound). El correo recibido aparece en list_emails con direction in.

ParámetroTipoObligatoriaDescripción
domain_idstringsíID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
local_partstringsíParte anterior a la @, p. ej. support. (máx. 64 caracteres)
namestringnoNombre visible opcional.
Devuelve{id: inb_…, address, name, status: active}.
Ejemplo de params de tools/call
{
  "name": "create_inbox",
  "arguments": {
    "domain_id": "dom_123",
    "local_part": "support",
    "name": "Support"
  }
}
Cambia el estadoupdate_inbox
PATCH /inboxes/:inbox_id

Renombrar, habilitar o deshabilitar una bandeja de entrada

Cambia el nombre de una bandeja de entrada o establece su estado en active / disabled.

ParámetroTipoObligatoriaDescripción
inbox_idstringsíID de la bandeja de entrada (empieza por inb_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
namestringnoNombre visible nuevo.
statusstringnoEstado nuevo. (uno de active, disabled)
DevuelveLa bandeja de entrada actualizada.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_inbox",
  "arguments": {
    "inbox_id": "inb_123",
    "status": "disabled"
  }
}
Envía correo realset_inbox_forwarding
PUT /inboxes/:inbox_id/forwarding

Reenviar una bandeja de entrada a otra dirección

SENDS REAL EMAIL cuando se reenvía a alguien distinto del propietario de la cuenta: define adónde se reenvía el correo recibido en una bandeja de entrada. La dirección del propio propietario se activa de inmediato; cualquier otra dirección recibe un correo de confirmación y el reenvío queda en pending hasta que alguien lo confirme allí. Pase forward_to: null para desactivar el reenvío. Las copias reenviadas salen desde la dirección de la bandeja de entrada, con el remitente original como Reply-To.

ParámetroTipoObligatoriaDescripción
inbox_idstringsíID de la bandeja de entrada (empieza por inb_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
forward_tostring,nullsíDirección de correo de destino del reenvío, o null para desactivarlo. (máx. 254 caracteres)
DevuelveLa bandeja de entrada con forwardTo y forwardStatus (off, pending o active).
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "set_inbox_forwarding",
  "arguments": {
    "inbox_id": "inb_123",
    "forward_to": "team@example.net"
  }
}
Destructivadelete_inbox
DELETE /inboxes/:inbox_id

Eliminar una bandeja de entrada

DESTRUCTIVE: elimina una dirección de entrada. El correo ya recibido se conserva; el correo nuevo a esa dirección deja de archivarse en ella.

ParámetroTipoObligatoriaDescripción
inbox_idstringsíID de la bandeja de entrada (empieza por inb_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}

Entregabilidad, rebotes y supresiones

Solo lecturadeliverability_stats
GET /deliverability/stats

Obtener estadísticas de entrega de 30 días

Totales de 30 días de todo el espacio de trabajo: sent, delivery, bounce, complaint, reject, open, click y deliveryRate (%).

Sin parámetros.

Devuelve{window: 30d, sent, delivery, bounce, complaint, reject, open, click, deliveryRate}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "deliverability_stats",
  "arguments": {}
}
Read-onlydeliverability_account
GET /deliverability/account

Get account delivery rates

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

ParámetroTipoObligatoriaDescripción
daysintegerno(one of 7, 30, 90)
Returns{days, trend, rolling7d, thresholds, ladder}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "deliverability_account",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_domains
GET /deliverability/domains

Get domain delivery rates

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

ParámetroTipoObligatoriaDescripción
daysintegerno
domainstringno
limitintegerno
offsetintegerno
Returns{days, data, count, limit, offset}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "deliverability_domains",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_senders
GET /deliverability/senders

Get sender delivery rates

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

ParámetroTipoObligatoriaDescripción
daysintegerno
domainstringno
limitintegerno
offsetintegerno
Returns{days, data, count, limit, offset}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "deliverability_senders",
  "arguments": {
    "days": 30
  }
}
Read-onlyscore_email
POST /deliverability/score

Score an email's content

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

ParámetroTipoObligatoriaDescripción
subjectstringnoThe subject line.
htmlstringnoThe HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars)
textstringnoThe plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars)
fromstringnoThe sender: an email address or a domain such as example.com. Without it, links to other sites are not judged. (max 320 chars)
Returns{score (0 to 100), deductions: [{id, points, count, suggestion}], warnings: [{id, message}]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "score_email",
  "arguments": {
    "from": "hello@example.com",
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
  }
}
Solo lecturalist_sender_reputation
GET /deliverability/reputation

Listar la reputación del remitente

Estado de reputación por dirección From exacta: active, throttled (límite diario más bajo) o paused (los envíos devuelven 423), con el motivo y el límite diario. Revíselo cuando los envíos fallen con 423 o 429. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{sender, status, dailyLimit, reason, cleanSince, warnedAt, pausedAt, evaluatedAt}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_sender_reputation",
  "arguments": {}
}
Solo lecturalist_suppressions
GET /suppressions

Listar supresiones

Lista de supresión del espacio de trabajo: destinatarios bloqueados tras un rebote permanente o una queja por spam. Los envíos a ellos fallan con 422. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{email, reason, detail, created_at}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_suppressions",
  "arguments": {}
}
Destructivaremove_suppression
DELETE /suppressions/:email

Quitar una supresión por rebote

DESTRUCTIVE (debilita un bloqueo de seguridad): quita una supresión por rebote para que se pueda volver a escribir a la dirección. Hágalo solo cuando la persona confirme que la dirección vuelve a ser válida. Las supresiones por queja no se pueden quitar (409).

ParámetroTipoObligatoriaDescripción
emailstringsíDirección del destinatario suprimido. (máx. 320 caracteres)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "remove_suppression",
  "arguments": {
    "email": "fixed-mailbox@example.net"
  }
}
Solo lecturalist_blocked_recipients
GET /blocked-recipients

Listar destinatarios bloqueados

Todos los destinatarios que SendHQ rechazará: rebotes, quejas y bajas de marketing con alcance por dominio, con un resumen por tipo. Lee hasta los 500 más recientes. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{email, domain, kind: bounce|complaint|unsubscribe, reason, detail, source, status, created_at}], count, summary: {total, bounce, complaint, unsubscribe}, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_blocked_recipients",
  "arguments": {}
}

Campaigns

Read-onlylist_contacts
GET /contacts

List contacts

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

ParámetroTipoObligatoriaDescripción
list_idstringnoOnly members of this list (lst_…).
statusstringnoOnly 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)
querystringnoEmail or name contains this text; * is a wildcard on the email. (max 200 chars)
tagstringnoOnly contacts with this tag. (max 60 chars)
sourcestringnoHow the contact was added. (one of form, api, import)
afterstringnoSigned up at or after this time. ISO 8601 date or date-time. (max 40 chars)
beforestringnoSigned up before this time. ISO 8601 date or date-time. (max 40 chars)
segment_idstringnoOnly contacts matching this saved segment (seg_…).
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [contacts with tags, engagement, dormant, country], count, total, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_contacts",
  "arguments": {
    "status": "subscribed"
  }
}
Changes statecreate_contact
POST /contacts

Add a contact

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

ParámetroTipoObligatoriaDescripción
emailstringsíEmail address. (max 320 chars)
namestringnoDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectnoCustom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field.
tagsstring[]noTags to attach, e.g. ["VIP"]. Up to 50. (0–50 items)
list_idsstring[]noLists to add the contact to (lst_…). (0–100 items)
statusstringnosubscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed)
consent_basisstringnoHow these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars)
ReturnsThe contact.
Ejemplo de params de tools/call
{
  "name": "create_contact",
  "arguments": {
    "email": "ada@example.net",
    "name": "Ada Lovelace",
    "consent_basis": "Ticked the newsletter box at checkout on acme.com"
  }
}
Changes stateupsert_contact
PUT /contacts

Create or update a contact by email

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

ParámetroTipoObligatoriaDescripción
emailstringsíEmail address. (max 320 chars)
namestringnoDisplay name; the first word is {{first_name}}. (max 200 chars)
fieldsobjectnoCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
tagsstring[]noTags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items)
timezonestringnoIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
localestringnoLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
consent_basisstringnoHow this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars)
ReturnsThe contact, plus timezone, locale, and created (true when it did not exist before).
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "upsert_contact",
  "arguments": {
    "email": "ada@example.net",
    "name": "Ada Lovelace",
    "fields": {
      "plan": "pro"
    },
    "timezone": "Europe/London",
    "consent_basis": "Created an account on acme.com and accepted product emails"
  }
}
Read-onlyget_contact
GET /contacts/:contact_id

Get a contact

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

ParámetroTipoObligatoriaDescripción
contact_idstringsíContact ID (starts with ct_) or the contact's email address. (max 320 chars)
ReturnsThe contact.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateupdate_contact
PATCH /contacts/:contact_id

Update, tag, or unsubscribe a contact

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

ParámetroTipoObligatoriaDescripción
contact_idstringsíContact ID (starts with ct_) or the contact's email address. (max 320 chars)
namestringnoNew display name. (max 200 chars)
fieldsobjectnoCustom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field.
tagsstring[]noReplace all of the contact's tags with these. (0–50 items)
add_tagsstring[]noTags to add. (0–50 items)
remove_tagsstring[]noTags to remove. (0–50 items)
statusstringnoOnly unsubscribed is accepted. (one of unsubscribed)
ReturnsThe updated contact.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_contact",
  "arguments": {
    "contact_id": "ct_123",
    "fields": {
      "plan": "team"
    }
  }
}
Destructivedelete_contact
DELETE /contacts/:contact_id

Delete a contact

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

ParámetroTipoObligatoriaDescripción
contact_idstringsíContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateimport_contacts
POST /contact-imports

Import contacts from CSV

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

ParámetroTipoObligatoriaDescripción
csvstringsíThe CSV file content, header row first. (max 5242880 chars)
list_idstringnoAdd every accepted row to this list (lst_…).
consent_basisstringsíHow these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars)
tagsstring[]noTags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items)
update_existingbooleannoMerge names and fields into contacts that already exist. Their status never changes.
Returns{id, accepted, created, existing, skipped, invalid, errors: [{line, reason}], tags}.
Ejemplo de params de tools/call
{
  "name": "import_contacts",
  "arguments": {
    "csv": "email,name\nada@example.net,Ada Lovelace\n",
    "consent_basis": "Newsletter signups exported from Mailchimp (double opt-in)"
  }
}
Read-onlylist_contact_imports
GET /contact-imports

List contact imports

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [imports], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_contact_imports",
  "arguments": {}
}
Destructivebulk_update_contacts
POST /contacts/bulk

Bulk update contacts

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

ParámetroTipoObligatoriaDescripción
actionstringsíWhat to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete)
contact_idsstring[]noContact IDs (ct_…). Use this or filter. (0–10000 items)
filterobjectnoEveryone matching these list_contacts filters. Use this or contact_ids.
filter.list_idstringnoMembers of this list.
filter.statusstringnoOnly 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.querystringnoEmail or name contains; * is an email wildcard. (max 200 chars)
filter.tagstringnoHas this tag. (max 60 chars)
filter.sourcestringnoHow the contact was added. (one of form, api, import)
filter.afterstringnoSigned up at or after. ISO 8601 date or date-time. (max 40 chars)
filter.beforestringnoSigned up before. ISO 8601 date or date-time. (max 40 chars)
filter.segment_idstringnoMatches this segment.
tagsstring[]noFor tag and untag. (0–50 items)
list_idstringnoFor add_to_list and remove_from_list (lst_…).
confirm_countintegernoFor delete: the number of contacts that will be deleted, from the 409 response. (0–…)
Returns{ok, action, count}; for an unconfirmed delete, a 409 error whose message gives the count.
AnnotationsdestructiveHint
Ejemplo de params de tools/call
{
  "name": "bulk_update_contacts",
  "arguments": {
    "action": "tag",
    "tags": [
      "october"
    ],
    "filter": {
      "list_id": "lst_123",
      "status": "subscribed"
    }
  }
}
Read-onlylist_tags
GET /tags

List contact tags

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{tag, count}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_tags",
  "arguments": {}
}
Read-onlylist_contact_fields
GET /contact-fields

List custom contact fields

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{key, label, type, createdAt}], count, types, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_contact_fields",
  "arguments": {}
}
Changes stateset_contact_field
PUT /contact-fields/:field_key

Define a custom contact field

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

ParámetroTipoObligatoriaDescripción
field_keystringsí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)
labelstringnoLabel shown in the dashboard. Defaults to the key. (max 80 chars)
typestringnotext (default), number, or date. (one of text, number, date)
Returns{key, label, type, createdAt}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "set_contact_field",
  "arguments": {
    "field_key": "plan",
    "label": "Plan",
    "type": "text"
  }
}
Destructivedelete_contact_field
DELETE /contact-fields/:field_key

Delete a custom field definition

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

ParámetroTipoObligatoriaDescripción
field_keystringsí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)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_contact_field",
  "arguments": {
    "field_key": "plan"
  }
}
Read-onlylist_segments
GET /segments

List segments

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{id, name, match, conditions, count}], count, fields, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_segments",
  "arguments": {}
}
Read-onlyget_segment
GET /segments/:segment_id

Get a segment

Campaigns: One segment with its conditions and live count.

ParámetroTipoObligatoriaDescripción
segment_idstringsíSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Returns{id, name, match, conditions, count}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlypreview_segment
POST /segments/preview

Preview segment conditions

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

ParámetroTipoObligatoriaDescripción
matchstringnoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]noUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsí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[].keystringnoCustom field key when field is field. (max 40 chars)
conditions[].opstringsítag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numbernoRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
Returns{count, sample: [contacts]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "preview_segment",
  "arguments": {
    "match": "all",
    "conditions": [
      {
        "field": "tag",
        "op": "has",
        "value": "VIP"
      },
      {
        "field": "opened",
        "op": "in_last_days",
        "value": 90
      }
    ]
  }
}
Changes statecreate_segment
POST /segments

Create a segment

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

ParámetroTipoObligatoriaDescripción
namestringsíSegment name. (max 120 chars)
matchstringnoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]noUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsí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[].keystringnoCustom field key when field is field. (max 40 chars)
conditions[].opstringsítag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numbernoRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
ReturnsThe segment with its count.
Ejemplo de params de tools/call
{
  "name": "create_segment",
  "arguments": {
    "name": "Engaged pro customers",
    "conditions": [
      {
        "field": "fields.plan",
        "op": "equals",
        "value": "pro"
      },
      {
        "field": "opened",
        "op": "in_last_days",
        "value": 90
      }
    ]
  }
}
Changes stateupdate_segment
PATCH /segments/:segment_id

Update a segment

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

ParámetroTipoObligatoriaDescripción
segment_idstringsíSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
namestringnoSegment name. (max 120 chars)
matchstringnoall (default): every condition must match. any: at least one. (one of all, any)
conditionsobject[]noUp to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items)
conditions[].fieldstringsí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[].keystringnoCustom field key when field is field. (max 40 chars)
conditions[].opstringsítag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt)
conditions[].valuestring,numbernoRequired except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after.
ReturnsThe updated segment with its count.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_segment",
  "arguments": {
    "segment_id": "seg_123",
    "name": "Pro customers"
  }
}
Destructivedelete_segment
DELETE /segments/:segment_id

Delete a segment

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

ParámetroTipoObligatoriaDescripción
segment_idstringsíSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlylist_lists
GET /lists

List contact lists

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [lists], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_lists",
  "arguments": {}
}
Changes statecreate_list
POST /lists

Create a list

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

ParámetroTipoObligatoriaDescripción
namestringsíList name, shown on the signup form. (max 200 chars)
descriptionstringnoShort description shown on the signup form. (max 500 chars)
form_enabledbooleannoPublish the hosted signup form.
form_fromstringnoSender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars)
redirect_urlstringnohttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectnoWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleannoSend it.
welcome.subjectstringnoSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringnoHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringnoMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectnoPublic 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.enabledbooleannoPublish the site.
site.slugstring,nullnoAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullnoSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullnoShort description under the title. (max 300 chars)
site.accentstring,nullnoAccent color, e.g. #0a7d4f.
ReturnsThe list.
Ejemplo de params de tools/call
{
  "name": "create_list",
  "arguments": {
    "name": "Product updates"
  }
}
Read-onlyget_list
GET /lists/:list_id

Get a list

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

ParámetroTipoObligatoriaDescripción
list_idstringsíList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
ReturnsThe list.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateupdate_list
PATCH /lists/:list_id

Update a list

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

ParámetroTipoObligatoriaDescripción
list_idstringsíList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
namestringnoNew name. (max 200 chars)
descriptionstringnoNew description. (max 500 chars)
form_enabledbooleannoPublish or unpublish the hosted signup form.
form_fromstringnoSender of signup confirmation emails, on a verified domain. (max 320 chars)
redirect_urlstringnohttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectnoWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleannoSend it.
welcome.subjectstringnoSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringnoHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringnoMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectnoPublic 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.enabledbooleannoPublish the site.
site.slugstring,nullnoAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullnoSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullnoShort description under the title. (max 300 chars)
site.accentstring,nullnoAccent color, e.g. #0a7d4f.
ReturnsThe updated list.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_list",
  "arguments": {
    "list_id": "lst_123",
    "form_enabled": false
  }
}
Destructivedelete_list
DELETE /lists/:list_id

Delete a list

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

ParámetroTipoObligatoriaDescripción
list_idstringsíList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateadd_list_contacts
POST /lists/:list_id/contacts

Add contacts to a list

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

ParámetroTipoObligatoriaDescripción
list_idstringsíList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idsstring[]noContact IDs (ct_…). (0–500 items)
emailsstring[]noContact email addresses. (0–500 items)
Returns{listId, added, notFound, list}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "add_list_contacts",
  "arguments": {
    "list_id": "lst_123",
    "emails": [
      "ada@example.net"
    ]
  }
}
Destructiveremove_list_contact
DELETE /lists/:list_id/contacts/:contact_id

Remove a contact from a list

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

ParámetroTipoObligatoriaDescripción
list_idstringsíList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idstringsíContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "remove_list_contact",
  "arguments": {
    "list_id": "lst_123",
    "contact_id": "ct_123"
  }
}
Read-onlylist_broadcasts
GET /broadcasts

List broadcasts

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

ParámetroTipoObligatoriaDescripción
statusstringnoOnly broadcasts with this status. (one of draft, sending, sent, cancelled, failed)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [broadcasts], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_broadcasts",
  "arguments": {}
}
Changes statecreate_broadcast
POST /broadcasts

Create a broadcast draft

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

ParámetroTipoObligatoriaDescripción
namestringnoInternal name. Defaults to the subject. (max 200 chars)
list_idstringnoThe list to send to (lst_…).
fromstringnoSender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars)
reply_tostringnoReply-To address. (max 320 chars)
subjectstringnoSubject line; merge tags allowed. (max 998 chars)
preview_textstringnoInbox preview text shown after the subject. (max 300 chars)
htmlstringnoHTML body; merge tags allowed and escaped.
textstringnoPlain-text body; merge tags allowed.
templateobjectnoA published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields.
template.idstringno
template.keystringno
template.version_idstringno
markdownstringnoMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullnoBlock 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.
editorstringnoWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectnoWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullnoOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringnoWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullnoSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectnoOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleannoAdd an open pixel.
tracking.clicksbooleannoRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectnoPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleannoPublish it.
web.slugstring,nullnoIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleannoKeep it at the top of the site.
ReturnsThe draft broadcast.
Ejemplo de params de tools/call
{
  "name": "create_broadcast",
  "arguments": {
    "list_id": "lst_123",
    "from": "news@example.com",
    "subject": "October update",
    "markdown": "Hi {{first_name | there}}, here's what shipped.",
    "audience": {
      "order": "engaged",
      "limit": 1000
    }
  }
}
Read-onlyget_broadcast
GET /broadcasts/:broadcast_id

Get a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe broadcast.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateupdate_broadcast
PATCH /broadcasts/:broadcast_id

Edit a draft broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
namestringnoInternal name. (max 200 chars)
list_idstringnoThe list to send to.
fromstringnoSender on a verified domain. (max 320 chars)
reply_tostringnoReply-To address. (max 320 chars)
subjectstringnoLínea de asunto. (máx. 998 caracteres)
preview_textstringnoInbox preview text. (max 300 chars)
htmlstringnoCuerpo HTML.
textstringnoCuerpo en texto sin formato.
templateobject,nullnoA published hosted template, or null to remove it.
markdownstringnoMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullnoBlock 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.
editorstringnoWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectnoWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullnoOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringnoWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullnoSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectnoOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleannoAdd an open pixel.
tracking.clicksbooleannoRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectnoPublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleannoPublish it.
web.slugstring,nullnoIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleannoKeep it at the top of the site.
ReturnsThe updated draft.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "subject": "October product update"
  }
}
Destructivedelete_broadcast
DELETE /broadcasts/:broadcast_id

Delete a draft broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast
POST /broadcasts/:broadcast_id/send

Send a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
idempotency_keystringnoEncabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres)
ReturnsThe broadcast with status sending and totals.
Ejemplo de params de tools/call
{
  "name": "send_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "idempotency_key": "october-update"
  }
}
Destructivecancel_broadcast
POST /broadcasts/:broadcast_id/cancel

Cancel a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe cancelled broadcast with totals.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "cancel_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlylist_broadcast_recipients
GET /broadcasts/:broadcast_id/recipients

List broadcast recipients

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
statusstringnoOnly recipients with this outcome. (one of queued, sending, sent, held, skipped, failed)
activitystringnoOnly recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed)
querystringnoRecipient email contains this text. (max 200 chars)
includestringnolinks adds the links each recipient clicked (implied by activity: clicked). (one of links)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{contactId, email, status, skipReason, emailId, error, provider, deliveredAt, openedAt, clickedAt, opens, clicks, bouncedAt, complainedAt, unsubscribedAt, links?}], count, totals, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_broadcast_recipients",
  "arguments": {
    "broadcast_id": "bc_123",
    "status": "failed"
  }
}
Read-onlycheck_broadcast
GET /broadcasts/:broadcast_id/checks

Run a broadcast's pre-send checks

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{ready, checks: [{id, level: ok|warn|block, label, detail}], audience: {total, matching}}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "check_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_test
POST /broadcasts/:broadcast_id/test

Send a broadcast test

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
tostring[]noTest recipients (up to 5). (1–5 items)
contact_idstringnoFill merge tags from this contact (ct_…). (max 320 chars)
rememberbooleannoSave to as the default test recipients.
Returns{data: [{to, id, status: sent|failed, error?}]}.
Ejemplo de params de tools/call
{
  "name": "send_broadcast_test",
  "arguments": {
    "broadcast_id": "bc_123",
    "to": [
      "owner@example.com"
    ]
  }
}
Sends real emailschedule_broadcast
POST /broadcasts/:broadcast_id/schedule

Schedule a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
scheduled_atstringsíWhen to send: ISO 8601 date-time with a timezone, at least a minute and at most a year ahead, e.g. 2026-11-10T09:00:00Z. (max 40 chars)
ReturnsThe broadcast with scheduledAt.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "schedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "scheduled_at": "2026-11-10T09:00:00Z"
  }
}
Changes stateunschedule_broadcast
POST /broadcasts/:broadcast_id/unschedule

Unschedule a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe draft broadcast.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "unschedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateduplicate_broadcast
POST /broadcasts/:broadcast_id/duplicate

Duplicate a broadcast

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe new draft broadcast.
Ejemplo de params de tools/call
{
  "name": "duplicate_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_to_more
POST /broadcasts/:broadcast_id/send-more

Send a broadcast to more people

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
limitintegersíHow many more people at most. (1–10000000)
idempotency_keystringnoEncabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres)
Returns{added, broadcast}.
Ejemplo de params de tools/call
{
  "name": "send_broadcast_to_more",
  "arguments": {
    "broadcast_id": "bc_123",
    "limit": 500,
    "idempotency_key": "october-update-more-1"
  }
}
Read-onlyget_broadcast_report
GET /broadcasts/:broadcast_id/report

Get a broadcast report

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

ParámetroTipoObligatoriaDescripción
broadcast_idstringsíBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{stats: {sent, delivered, opened, clicked, bounced, complained, unsubscribed, opens, clicks, rates}, providers, links, timeline, average, machine, tracking, totals, remaining}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_broadcast_report",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlyget_newsletter_settings
GET /newsletter-settings

Get newsletter settings

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

Sin parámetros.

Returns{postalAddress, design: {accentColor, font, align}, cleanup: {enabled, afterSends, quietDays, subject, body, from}, testRecipients}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_newsletter_settings",
  "arguments": {}
}
Changes stateupdate_newsletter_settings
PATCH /newsletter-settings

Update newsletter settings

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

ParámetroTipoObligatoriaDescripción
postal_addressstringnoSender's postal address for the footer. Empty string removes it. (max 300 chars)
designobjectnoRendering design for Markdown and block content.
design.accentColorstring,nullnoHex color like #0a7d4f, or null for the default.
design.fontstringnoFont family. (one of sans, serif, mono)
design.alignstringnoText alignment. (one of left, center)
cleanupobjectnoList cleanup of readers who stopped opening.
cleanup.enabledbooleannoTurn list cleanup on or off.
cleanup.afterSendsintegernoBroadcasts in a row without an open or click (3-50). (3–50)
cleanup.quietDaysintegernoDays without engagement (30-730). (30–730)
cleanup.subjectstring,nullnoSubject of the cleanup email; merge tags allowed. (max 200 chars)
cleanup.bodystring,nullnoBody text of the cleanup email. (max 2000 chars)
cleanup.fromstring,nullnoSender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars)
test_recipientsstring[]noDefault addresses for send_broadcast_test (up to 5). (0–5 items)
ReturnsThe updated settings.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_newsletter_settings",
  "arguments": {
    "postal_address": "Acme Inc., 1 Main St, Springfield",
    "design": {
      "accentColor": "#0a7d4f"
    }
  }
}
Read-onlyget_campaign_overview
GET /campaigns/overview

Get campaign overview

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

ParámetroTipoObligatoriaDescripción
daysintegernoWindow in days, 7 to 365. Defaults to 30. (7–365)
Returns{subscribers: {active, dormant, pending, joined, left}, series: [{day, subscribers, joined, left}], recent: [{id, name, subject, status, startedAt, sent, openRate, clickRate}], averages}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_campaign_overview",
  "arguments": {
    "days": 30
  }
}
Read-onlylist_uploaded_images
GET /uploads/images

List uploaded images

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{id, url, width, height, size, filename, createdAt}], pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_uploaded_images",
  "arguments": {}
}

Automations, events, and sending limits

Sends real emailtrack_event
POST /events

Record something a contact did

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

ParámetroTipoObligatoriaDescripción
emailstringsíThe contact's email address. (max 320 chars)
eventstringsíWhat they did: a lowercase letter, then a-z, 0-9, and _ (e.g. checkout_started). Names starting email. are reserved. (max 64 chars)
propertiesobjectnoUp 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_atstringnoWhen 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_keystringnoStable ID for this event (max 200 chars). A second call with the same key records nothing and returns the first result. (max 200 chars)
contactobjectnoChanges to the contact, applied with the event.
contact.namestringnoDisplay name. (max 200 chars)
contact.fieldsobjectnoCustom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field.
contact.timezonestringnoIANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars)
contact.localestringnoLanguage tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars)
contact.consent_basisstringnoHow this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars)
Returns{id, contact_id, started: [automation keys the contact entered], ended: [automation keys the contact left]}.
Ejemplo de params de tools/call
{
  "name": "track_event",
  "arguments": {
    "email": "ada@example.net",
    "event": "checkout_started",
    "properties": {
      "plan": "pro"
    },
    "dedupe_key": "checkout_8f3a"
  }
}
Read-onlylist_automations
GET /automations

List automations

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

ParámetroTipoObligatoriaDescripción
domainstringnoOnly 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)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at} plus steps_count and totals], count, domains: [{domain, count}], pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_automations",
  "arguments": {
    "domain": "example.com"
  }
}
Read-onlyget_automation
GET /automations/:automation_key

Get an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
ReturnsThe automation (with domain, the domain of its from_address, or null) with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, overlap [{key, name, contacts, position, goes_first}], merge_fields [{key, label}]: the merge tags its emails print, in plain words, and to_fill [{id, position, locale, where, placeholder, key, message}].
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Changes statecreate_automation
POST /automations

Create an automation

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

ParámetroTipoObligatoriaDescripción
keystringsíAddress of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars)
namestringsíName shown in the dashboard. (max 200 chars)
audience_labelstringnoWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringnoWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectnoHow 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.typestringsíEntry type. (one of event, bucket, date_field, manual)
entry.eventstringnoEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringnoSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringnoContact field key for a date_field entry. (max 40 chars)
entry.reentrystringnoWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectnoWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullnoEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleannoTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]noEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegernoDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectnoPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleannoSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullnoAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullnoStored 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_pctnumbernoPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegernoAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegernoHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegernoPriority. 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_namestringnoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnoReply-To address. (max 320 chars)
stepsobject[]noThe emails, in order. position defaults to the place in this list. (0–50 items)
steps[].positionintegernoPosition of the email in the automation, 1 to 50. (1–50)
steps[].subjectstringnoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
steps[].preheaderstringnoInbox preview line. (max 300 chars)
steps[].contentobjectnoBlock 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[].htmlstringnoHTML body. The unsubscribe footer is added automatically.
steps[].textstringnoCuerpo en texto sin formato.
steps[].editorstringnoHow 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_secondsintegernoWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
steps[].skip_if_emptystring[]noMerge 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_windowbooleannoSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
Ejemplo de params de tools/call
{
  "name": "create_automation",
  "arguments": {
    "key": "checkout-recovery",
    "name": "Checkout recovery",
    "audience_label": "Started checkout and left",
    "goal_label": "paid",
    "from_name": "Acme",
    "from_address": "hello@example.com",
    "entry": {
      "type": "event",
      "event": "checkout_started"
    },
    "exit_rules": {
      "goal_event": "payment_completed"
    },
    "steps": [
      {
        "offset_seconds": 3600,
        "subject": "Still thinking it over, {{ first_name | there }}?",
        "html": "<p>Your cart is waiting.</p>"
      }
    ]
  }
}
Changes stateupdate_automation
PATCH /automations/:automation_key

Edit an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
namestringnoName shown in the dashboard. (max 200 chars)
audience_labelstringnoWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringnoWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectnoHow 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.typestringsíEntry type. (one of event, bucket, date_field, manual)
entry.eventstringnoEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringnoSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringnoContact field key for a date_field entry. (max 40 chars)
entry.reentrystringnoWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectnoWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullnoEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleannoTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]noEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegernoDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectnoPer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleannoSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullnoAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullnoStored 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_pctnumbernoPercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegernoAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegernoHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegernoPriority. 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_namestringnoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnoReply-To address. (max 320 chars)
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_automation",
  "arguments": {
    "automation_key": "checkout-recovery",
    "name": "Checkout recovery",
    "settings": {
      "holdout_pct": 10
    }
  }
}
Destructivedelete_automation
DELETE /automations/:automation_key

Delete an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Changes stateset_automation_step
PUT /automations/:automation_key/steps/:position

Create or change an email of an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersíPosition of the email in the automation, 1 to 50. (1–50)
templatestringnoId 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)
subjectstringnoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringnoInbox preview line. (max 300 chars)
contentobjectnoBlock 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.
htmlstringnoHTML body. The unsubscribe footer is added automatically.
textstringnoCuerpo en texto sin formato.
editorstringnoHow 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_secondsintegernoWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
skip_if_emptystring[]noMerge 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_windowbooleannoSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe email: {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "set_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 2,
    "offset_seconds": 86400,
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p>"
  }
}
Destructivedelete_automation_step
DELETE /automations/:automation_key/steps/:position

Remove an email from an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersíPosition of the email in the automation, 1 to 50. (1–50)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 3
  }
}
Changes stateset_automation_step_variant
PUT /automations/:automation_key/steps/:position/variants/:locale

Create or change a language version of an email

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersíPosition of the email in the automation, 1 to 50. (1–50)
localestringsíLanguage tag of the version, e.g. fr or pt-br. (max 35 chars)
subjectstringnoSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringnoInbox preview line. (max 300 chars)
contentobjectnoBlock 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.
htmlstringnoHTML body. The unsubscribe footer is added automatically.
textstringnoCuerpo en texto sin formato.
Returns{locale, subject, preheader, content, html, text, updated_at}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "set_automation_step_variant",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1,
    "locale": "fr",
    "subject": "Vous hésitez encore ?",
    "html": "<p>Votre panier vous attend.</p>"
  }
}
Sends real emailset_automation_status
POST /automations/:automation_key/status

Turn an automation on or off

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
statusstringsíon to start sending, off to stop. (one of on, off)
ReturnsThe automation: {id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "set_automation_status",
  "arguments": {
    "automation_key": "checkout-recovery",
    "status": "off"
  }
}
Sends real emailsend_automation_test_email
POST /automations/:automation_key/steps/:position/test

Send one automation email to yourself as a test

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegersíPosition of the email in the automation, 1 to 50. (1–50)
localestringnoSend 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)
sampleobjectnoValues 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_runbooleannoSend nothing; return the email as the test would deliver it.
Returns{to, position, locale, subject, id: em_…, status: sent|held}. With dry_run: {dry_run: true, to, from, position, locale, locales, subject, preheader, html, text, sample: [{key, label, value}]}.
Ejemplo de params de tools/call
{
  "name": "send_automation_test_email",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1
  }
}
Sends real emailsend_automation_test
POST /automations/:automation_key/test

Send every email of an automation to yourself as tests

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
localestringnoSend 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)
sampleobjectnoValues to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set.
Returns{to, data: [{position, locale, subject, id: em_…, status: sent|held|failed, error?}], count, sent, failed, not_sent}.
Ejemplo de params de tools/call
{
  "name": "send_automation_test",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Sends real emailenroll_contact
POST /automations/:automation_key/enroll

Add a contact to an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringsíEmail address of an existing contact. (max 320 chars)
propertiesobjectnoUp 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_atstringnoThe moment the emails' offsets count from, ISO 8601 with a time zone. Defaults to now; may lie ahead for emails that lead up to a date. (max 40 chars)
ReturnsThe enrolment: {id, automation_key, contact_id, status, source, is_holdout, anchor_at, entered_at, next_due_at, exit_reason, ended_at, converted_at}.
Ejemplo de params de tools/call
{
  "name": "enroll_contact",
  "arguments": {
    "automation_key": "checkout-recovery",
    "email": "ada@example.net",
    "properties": {
      "plan": "pro"
    }
  }
}
Changes stateexit_contact
POST /automations/:automation_key/exit

Take a contact out of an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringsíEmail address of the contact. (max 320 chars)
reasonstringnoWhy, for the record (max 200 chars). Defaults to manual. (max 200 chars)
ReturnsThe ended enrolment: {id, automation_key, contact_id, status, source, is_holdout, anchor_at, entered_at, next_due_at, exit_reason, ended_at, converted_at}.
Ejemplo de params de tools/call
{
  "name": "exit_contact",
  "arguments": {
    "automation_key": "checkout-recovery",
    "email": "ada@example.net",
    "reason": "Asked support to stop"
  }
}
Read-onlypreview_automation
GET /automations/:automation_key/preview

Preview what an automation would send now

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{automation_key, status, evaluated_at, data: [{enrollment_id, contact_id, email, status, next_due_at, outcome, reason, until, step: {position, subject, locale}, behind: {key, name}, superseded}], count, counts, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "preview_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlyget_automations_overview
GET /automations/overview

Get results across all automations

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

ParámetroTipoObligatoriaDescripción
fromstringnoFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringnoLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
domainstringnoOnly the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars)
Returns{from, to, totals: {entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}, series: [{day, entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_automations_overview",
  "arguments": {
    "from": "2026-10-20",
    "to": "2026-11-18"
  }
}
Read-onlyget_automation_report
GET /automations/:automation_key/report

Get the results of one automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
fromstringnoFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringnoLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
Returns{automation: {key, name, status, goal_label}, from, to, totals, series: [{day, ...}], steps: [{step_id, position, subject, offset_seconds, archived, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}]}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_automation_report",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlylist_automation_people
GET /automations/:automation_key/people

List the people in an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
didstringnoWhat the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting)
stepintegernoOnly this email of the automation, by its position. (1–50)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{automation_key, did, step, data: [{contact_id, email, name, contact_status, enrollment_id, enrollment_status, at, latest: {did, at, step_position, reason}}], count, next_cursor, counts, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_automation_people",
  "arguments": {
    "automation_key": "checkout-recovery",
    "did": "clicked"
  }
}
Read-onlyget_automation_person
GET /automations/:automation_key/people/:contact_id

Get one person's history in an automation

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

ParámetroTipoObligatoriaDescripción
automation_keystringsíAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
contact_idstringsíContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Returns{automation_key, contact: {id, email, name, status}, enrollments: [{id, status, source, is_holdout, anchor_at, entered_at, next_due_at, last_sent_at, exit_reason, ended_at, converted_at, converted_send_id}], sends: [{id, enrollment_id, step_id, step_position, subject, status, skip_reason, locale, email_id, sent_at, delivered_at, opened_at, clicked_at, bounced_at, complained_at, unsubscribed_at, converted_at, open_count, machine_open_count, click_count, events: [{kind, machine, reason, position, url, country, at}]}], conversion: {enrollment_id, converted_at, goal_event, send_id, step_position}}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_automation_person",
  "arguments": {
    "automation_key": "checkout-recovery",
    "contact_id": "ct_123"
  }
}
Read-onlyget_sending_limits
GET /automation-settings

Get automation sending limits

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

Sin parámetros.

Returns{max_emails, period_days, min_gap_hours, window_start, window_end, weekdays, default_timezone, product_name, sender_name, updated_at}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_sending_limits",
  "arguments": {}
}
Changes stateupdate_sending_limits
PUT /automation-settings

Update automation sending limits

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

ParámetroTipoObligatoriaDescripción
max_emailsintegernoMost automation emails one person may get in period_days. Default 2. (1–50)
period_daysintegernoThe period max_emails applies to, in days. Default 7. (1–90)
min_gap_hoursintegernoLeast time between two automation emails to one person, in hours. Default 44. (0–720)
window_startintegernoFirst hour of the day emails may go out, local time (0-23). Default 9. (0–23)
window_endintegernoHour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24)
weekdaysinteger[]noDays emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items)
default_timezonestringnoIANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars)
product_namestringnoYour product's name, for {{ product_name }}. (max 120 chars)
sender_namestringnoWho the emails are from, for {{ sender_name }}. (max 120 chars)
ReturnsThe updated limits.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_sending_limits",
  "arguments": {
    "max_emails": 3,
    "min_gap_hours": 24,
    "default_timezone": "Europe/London"
  }
}
Read-onlylist_automation_templates
GET /automation-library

List automation templates

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{version, groups, data: [{id, kind, name, purpose, group, set, subject, preview_text, needs_consent, start: {entry, offset_seconds, goal_event, goal_label, skip_if_empty}, merge_keys, fill_in: [{kind, key, placeholder, label, example}]}], sets: [{id, kind, name, purpose, group, needs_consent, emails: [{template, offset_seconds}], start, merge_keys, fill_in}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_automation_templates",
  "arguments": {}
}
Read-onlyget_automation_template
GET /automation-library/:template_id

Get an automation template

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

ParámetroTipoObligatoriaDescripción
template_idstringsíId of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars)
Returns{id, kind (email or set), name, purpose, group, set, needs_consent, start: {entry, goal_event, goal_label}, merge_keys, fill_in: [{kind, key, placeholder, label, example}], emails: [{template, name, offset_seconds, skip_if_empty, subject, preview_text, content, preview: {subject, preheader, text, html}}]}. preview.html is null.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_automation_template",
  "arguments": {
    "template_id": "welcome-note"
  }
}
Changes stateuse_automation_template
POST /automation-library/:template_id/use

Create an automation from a template

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

ParámetroTipoObligatoriaDescripción
template_idstringsí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)
keystringnoAddress 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)
namestringnoName shown in the dashboard. Defaults to the template's own name. (max 200 chars)
from_namestringnoSender display name, e.g. Acme. (max 120 chars)
from_addressstringnoSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringnoReply-To address. (max 320 chars)
ReturnsThe new automation (status draft) with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), merge_fields [{key, label}], template, and to_fill [{id, position, locale, where, placeholder, key, message}]: what must be filled in before it can be turned on.
Ejemplo de params de tools/call
{
  "name": "use_automation_template",
  "arguments": {
    "template_id": "welcome-note",
    "name": "Welcome",
    "from_name": "Dana from Acme",
    "from_address": "dana@example.com"
  }
}
Read-onlylist_events
GET /events

List what contacts did

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

ParámetroTipoObligatoriaDescripción
contactstringnoOnly this contact: a contact ID or an email address. (max 320 chars)
namestringnoOnly this event, e.g. checkout_started. See list_event_names. (max 64 chars)
fromstringnoEvents from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars)
tostringnoEvents up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars)
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{id, contact: {id, email, name}, event, words, occurred_at, received_at, source: {type, label, connection_id}, properties, effects: [{did, automation_key, automation_name}]}], count, next_cursor, enrollments (with contact), pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_events",
  "arguments": {
    "name": "checkout_started",
    "from": "2026-11-01"
  }
}
Read-onlylist_event_names
GET /events/names

List the kinds of event recorded

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{event, words, count}], count, days, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_event_names",
  "arguments": {}
}
Read-onlylist_connections
GET /connections

List connections

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

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Returns{data: [{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery {id, at, result, reason, recorded, events, text, provider_event, email}], count, limit, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_connections",
  "arguments": {}
}
Read-onlyget_connection
GET /connections/:connection_id

Get a connection and its last deliveries

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

ParámetroTipoObligatoriaDescripción
connection_idstringsíConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery and deliveries: [{id, at, result, reason, recorded, events, text, provider_event, email}].
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}
Sends real emailcreate_connection
POST /connections

Create a connection

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

ParámetroTipoObligatoriaDescripción
namestringsíWhat to call it, e.g. Stripe. (max 80 chars)
kindstringsístripe, dodo, or generic. (one of generic, stripe, dodo)
consent_basisstringsí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_prefixstringnoPut in front of every event name, e.g. stripe_. (max 32 chars)
enabledbooleannoDefaults to true. Pass false to create it switched off.
mappingobjectnoFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringnoWhere the contact's email address is. (max 120 chars)
mapping.eventstringnoWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringnoOne fixed event name, instead of event. (max 64 chars)
mapping.timestringnoWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringnoWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]noThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus address (shown once) and last_delivery: null.
Ejemplo de params de tools/call
{
  "name": "create_connection",
  "arguments": {
    "name": "Stripe",
    "kind": "stripe",
    "consent_basis": "Bought a plan on acme.com and accepted product emails"
  }
}
Sends real emailupdate_connection
PATCH /connections/:connection_id

Change a connection or switch it on or off

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

ParámetroTipoObligatoriaDescripción
connection_idstringsíConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
namestringnoA new name. (max 80 chars)
enabledbooleannotrue: record what arrives. false: answer 404 and record nothing.
consent_basisstringnoHow 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_prefixstringnoPut in front of every event name, e.g. stripe_. (max 32 chars)
mappingobjectnoFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringnoWhere the contact's email address is. (max 120 chars)
mapping.eventstringnoWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringnoOne fixed event name, instead of event. (max 64 chars)
mapping.timestringnoWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringnoWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]noThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at}.
AnotacionesidempotentHint
Ejemplo de params de tools/call
{
  "name": "update_connection",
  "arguments": {
    "connection_id": "acn_123",
    "enabled": false
  }
}
Destructivedelete_connection
DELETE /connections/:connection_id

Delete a connection

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

ParámetroTipoObligatoriaDescripción
connection_idstringsíConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Devuelve{ok: true}.
AnotacionesdestructiveHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "delete_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}

Cuenta, uso, analíticas y claves

Solo lecturaget_account
GET /account

Obtener la cuenta, el uso y la facturación

Correo del propietario de la cuenta, plan/nivel de acceso, entregas a destinatarios usadas en el periodo actual frente a la cuota, dominios usados frente al límite, transferencia de adjuntos, resumen de reputación, estado de la suscripción, planes publicados y recuentos del espacio de trabajo. Úselo para comprobar la cuota restante o a quién puede entregar la prueba (el correo de la cuenta).

Sin parámetros.

Devuelve{user: {email, …}, usage: {domainsUsed, domainLimit, recipientDeliveries, emailQuotaMonth, attachmentBytes, attachmentByteLimit, periodKey}, access: {tier, planCode}, reputation, infrastructure, billing: {status, subscriptions, …}, plans, workspace: {mailer, stats}}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_account",
  "arguments": {}
}
Read-onlyget_account_diagnostics
GET /account/diagnostics

Diagnose sending and receiving

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

Sin parámetros.

Returns{generatedAt, windowDays, issues: [{severity, code, message}], plan: {tier, usage, sendingLimit}, domains: [{name, status, dkim: {required, verified, missing}, inbound}], sendingIdentities, inbound, deliverability: {sent, delivered, bounced, complained, rates, senders}, suppressions: {total, byReason, unsubscribes, recent}, failures: {notSent, recentNotSent, recentProviderEvents}, webhooks}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_account_diagnostics",
  "arguments": {}
}
Solo lecturaget_analytics
GET /analytics

Obtener analíticas de envío

Analíticas del panel de los últimos 7, 30 o 90 días: totales de enviados/recibidos/entregados/rebotados/bloqueados/abiertos/con clic/quejas, una línea de tiempo diaria, los principales dominios de envío y los asuntos más frecuentes.

ParámetroTipoObligatoriaDescripción
daysintegernoVentana en días: 7, 30 (predeterminado) o 90. (uno de 7, 30, 90)
Devuelve{window, days, metrics, timeline: [{day, sent, received}], domains, topContent}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_analytics",
  "arguments": {
    "days": 30
  }
}
Solo lecturalist_api_keys
GET /keys

Listar los metadatos de las claves de API

Lista los nombres de las claves de API, los prefijos no secretos y las fechas de último uso. Solo lectura: este servidor MCP no puede crear, rotar ni revocar claves; eso lo hace una persona en el panel. Paginado: el resultado incluye pagination {offset, limit, returned, total?, has_more, next_offset}.

ParámetroTipoObligatoriaDescripción
limitintegernoTamaño de página. Por defecto, 50. (predeterminado 50; 1–200)
offsetintegernoNúmero de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…)
Devuelve{data: [{id, name, prefix, lastUsedAt, createdAt}], count, pagination}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "list_api_keys",
  "arguments": {}
}
Solo lecturaget_service_health
GET /health

Comprobar el estado del servicio SendHQ

Comprueba que la API de SendHQ está operativa y qué proveedor de correo está activo. No necesita una clave de API válida.

Sin parámetros.

Devuelve{ok, service, mailer}.
AnotacionesreadOnlyHint idempotentHint
Ejemplo de params de tools/call
{
  "name": "get_service_health",
  "arguments": {}
}

Inventario de cobertura de la API

Cada operación de la API pública y la herramienta que la cubre. Todo lo que un usuario puede hacer en el panel y que tiene API está cubierto; las exclusiones que se indican abajo son deliberadas.

EndpointHerramientaNotas
POST /emailssend_emailEnviar un correo
POST /emails/batchsend_batchEnviar hasta 100 mensajes personalizados
GET /emailslist_emailsListar el correo enviado y recibido
GET /emails/:idget_emailObtener un correo y sus adjuntos
PATCH /emails/:idmark_emailActualizar leído, archivado, spam, categoría o importancia
POST /emails/:id/labelslabel_emailAgregar o quitar etiquetas de un correo
DELETE /emails/:iddelete_emailEliminar un correo conservado
GET /emails/:id/eventslist_email_eventsListar los eventos de entrega de un correo
GET /threads/:idget_threadObtener una conversación en orden cronológico
GET /labelslist_labelsListar etiquetas con recuentos de mensajes y reglas de archivado
POST /labelscreate_labelCrear una etiqueta, opcionalmente con reglas de archivado automático
GET /labels/:idget_labelObtener una etiqueta por ID o nombre
PATCH /labels/:idupdate_labelRenombrar, cambiar el color o convertir una etiqueta en categoría
DELETE /labels/:iddelete_labelEliminar una etiqueta sin eliminar su correo
POST /labels/:id/rulescreate_label_ruleAgregar una regla de archivado automático a una etiqueta
DELETE /labels/:id/rules/:rule_iddelete_label_ruleEliminar una regla de archivado automático
POST /draftscreate_draftCrear un borrador del editor
GET /draftslist_draftsListar los borradores del editor
GET /drafts/:idget_draftObtener un borrador y sus adjuntos
PUT /drafts/:idupdate_draftReemplazar el contenido de un borrador
DELETE /drafts/:iddelete_draftDescartar un borrador
POST /drafts/:id/attachmentsupload_attachmentSubir un adjunto a un borrador
GET /attachments/:iddownload_attachmentDescargar un adjunto privado
DELETE /attachments/:iddelete_attachmentEliminar un adjunto privado
GET /sending-identitieslist_sending_identitiesListar las identidades de remitente verificadas
GET /templateslist_templatesListar plantillas alojadas
POST /templatescreate_templateCrear una plantilla alojada
GET /templates/:idget_templateObtener borradores, versiones y uso
PUT /templates/:id/draftupdate_template_draftGuardar automáticamente el borrador de una plantilla
POST /templates/:id/draftcreate_template_draftCrear un borrador nuevo a partir de la versión publicada
POST /templates/:id/renderrender_templateRenderizar la salida exacta del servidor
POST /templates/:id/testsend_template_testEnviar una instantánea de prueba
POST /templates/:id/publishpublish_templatePublicar una versión inmutable de la plantilla
POST /templates/:id/archivearchive_templateArchivar una plantilla
POST /templates/:id/restorerestore_templateRestaurar una plantilla archivada
POST /domainsadd_domainAgregar un dominio de envío
GET /domainslist_domainsListar dominios y el estado DNS en caché
GET /domains/:idget_domainObtener los detalles de configuración de un dominio
POST /domains/:id/verifyverify_domainRefresh domain and DNS verification
POST /domains/:id/inbound/setupsetup_inboundProvision inbound receiving
POST /domains/:id/inbound/verifyverify_inboundVerificar el enrutamiento MX de entrada
DELETE /domains/:iddelete_domainEliminar un dominio
GET /dns/providerget_dns_providerDetectar el proveedor de DNS autoritativo y los hosts relativos de los registros
GET /dns/domain-connect/connectget_domain_connect_linkCrear un enlace de consentimiento de Domain Connect para la configuración DNS con un clic
POST /inboxescreate_inboxCrear una dirección de entrada
GET /inboxeslist_inboxesListar direcciones de entrada
GET /inboxes/:idget_inboxObtener una dirección de entrada
PATCH /inboxes/:idupdate_inboxRenombrar, habilitar o deshabilitar una bandeja de entrada
PUT /inboxes/:id/forwardingset_inbox_forwardingReenviar el correo recibido en una bandeja de entrada a otra dirección
DELETE /inboxes/:iddelete_inboxEliminar una bandeja de entrada conservando los mensajes
GET /deliverability/statsdeliverability_statsObtener las estadísticas de entrega de 30 días
GET /deliverability/reputationlist_sender_reputationListar el estado de reputación por identidad de remitente exacta
GET /deliverability/accountdeliverability_accountAccount delivery rates, daily ladder, and bounce trend
GET /deliverability/domainsdeliverability_domainsPer-domain sent, delivered, hard and soft bounces, complaints, and failures
GET /deliverability/sendersdeliverability_sendersPer-From-address delivery rates
POST /deliverability/scorescore_emailScore an email's content before it is sent
GET /emails/:id/deliveryemail_deliveryDelivery timeline for one email, with bounce and complaint reasons
GET /threads/:id/deliverythread_deliveryPer-thread delivery counts and per-message failure reasons
GET /suppressionslist_suppressionsListar las supresiones del espacio de trabajo
DELETE /suppressions/:emailremove_suppressionQuitar una supresión por rebote que cumpla los requisitos
GET /blocked-recipientslist_blocked_recipientsListar rebotes, quejas y bajas
GET /webhooksno expuestoWebhook 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 /webhooksno expuestoWebhook 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/:idno expuestoWebhook 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/:idno expuestoWebhook 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/:idno expuestoWebhook 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-secretno expuestoWebhook 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/testno expuestoWebhook 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/deliveriesno expuestoWebhook 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/:deliveryIdno expuestoWebhook 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/retryno expuestoWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /contactslist_contactsList contacts
POST /contactscreate_contactAdd a contact with its consent basis
PUT /contactsupsert_contactCreate or update a contact by email
POST /contacts/bulkbulk_update_contactsTag, move, unsubscribe, or delete many contacts at once
GET /contacts/exportno expuestoImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /contacts/:idget_contactRetrieve a contact by ID or email
PATCH /contacts/:idupdate_contactUpdate a contact's name, fields, or tags, or unsubscribe it
DELETE /contacts/:iddelete_contactDelete a contact and its list memberships
POST /contact-importsimport_contactsImport contacts from CSV
GET /contact-importslist_contact_importsList recent contact imports
GET /tagslist_tagsList contact tags with how many contacts carry each
GET /contact-fieldslist_contact_fieldsList custom contact field definitions
PUT /contact-fields/:keyset_contact_fieldDefine or change a custom contact field
DELETE /contact-fields/:keydelete_contact_fieldDelete a custom field definition
GET /segmentslist_segmentsList saved segments with live counts
POST /segmentscreate_segmentSave a segment
POST /segments/previewpreview_segmentCount and sample the contacts that match unsaved conditions
GET /segments/:idget_segmentRetrieve a segment and its live count
PATCH /segments/:idupdate_segmentRename a segment or change its conditions
DELETE /segments/:iddelete_segmentDelete a segment
GET /listslist_listsList contact lists with member counts
POST /listscreate_listCreate a list with an optional signup form, welcome email, and newsletter site
GET /lists/:idget_listRetrieve a list
PATCH /lists/:idupdate_listRename a list or change its signup form, welcome email, or site
DELETE /lists/:iddelete_listDelete a list without deleting its contacts
POST /lists/:id/contactsadd_list_contactsAdd existing contacts to a list
DELETE /lists/:id/contacts/:contact_idremove_list_contactRemove a contact from a list
GET /broadcastslist_broadcastsList broadcasts
POST /broadcastscreate_broadcastCreate a broadcast draft
GET /broadcasts/:idget_broadcastRetrieve a broadcast and its delivery totals
PATCH /broadcasts/:idupdate_broadcastEdit a draft broadcast
DELETE /broadcasts/:iddelete_broadcastDelete a draft broadcast
GET /broadcasts/:id/checkscheck_broadcastRun the pre-send checks for a broadcast
POST /broadcasts/:id/testsend_broadcast_testSend a test copy of a draft
POST /broadcasts/:id/scheduleschedule_broadcastSchedule a draft to send later
POST /broadcasts/:id/unscheduleunschedule_broadcastUnschedule a draft
POST /broadcasts/:id/duplicateduplicate_broadcastCopy a broadcast into a new draft
POST /broadcasts/:id/sendsend_broadcastSend a broadcast to its audience
POST /broadcasts/:id/send-moresend_broadcast_to_moreSend a sent broadcast to more of its audience
POST /broadcasts/:id/cancelcancel_broadcastCancel a draft or sending broadcast
GET /broadcasts/:id/recipientslist_broadcast_recipientsList a broadcast's recipients, outcomes, and engagement
GET /broadcasts/:id/reportget_broadcast_reportRetrieve a broadcast's engagement report
GET /campaigns/overviewget_campaign_overviewRetrieve subscriber growth and recent broadcast performance
GET /newsletter-settingsget_newsletter_settingsRetrieve newsletter settings
PATCH /newsletter-settingsupdate_newsletter_settingsChange newsletter settings
POST /uploads/imagesno expuestoImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /uploads/imageslist_uploaded_imagesList recently uploaded images
POST /eventstrack_eventRecord something a contact did
POST /events/batchno expuestoHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automationslist_automationsList automations with their 30-day totals
POST /automationscreate_automationCreate an automation as a draft
GET /automations/:keyget_automationRetrieve an automation with its emails
PATCH /automations/:keyupdate_automationEdit an automation
DELETE /automations/:keydelete_automationDelete an automation and its history
PUT /automations/:key/steps/:positionset_automation_stepCreate or change one email of an automation
DELETE /automations/:key/steps/:positiondelete_automation_stepRemove one email from an automation
PUT /automations/:key/steps/:position/variants/:localeset_automation_step_variantCreate or change a language version of an email
POST /automations/:key/steps/:position/testsend_automation_test_emailSend one email of an automation to yourself as a test
POST /automations/:key/testsend_automation_testSend every email of an automation to yourself as tests
POST /automations/:key/statusset_automation_statusTurn an automation on or off
POST /automations/:key/enrollenroll_contactAdd a contact to an automation
POST /automations/:key/exitexit_contactTake a contact out of an automation
GET /automations/:key/previewpreview_automationDry run: what each person in an automation would get now
GET /automations/overviewget_automations_overviewTotals and a daily series across every automation
GET /automations/:key/reportget_automation_reportResults of one automation, with one row per email
GET /automations/:key/peoplelist_automation_peopleList the people in an automation by what they did
GET /automations/:key/people/:contact_idget_automation_personOne person's history in an automation
POST /automations/:key/import-historyno expuestoHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automation-settingsget_sending_limitsRetrieve the workspace's sending limits for automations
PUT /automation-settingsupdate_sending_limitsChange the workspace's sending limits for automations
GET /automation-librarylist_automation_templatesList the template library: ready-made lifecycle emails
GET /automation-library/:idget_automation_templateRead one template or set, with the email as it will look
POST /automation-library/:id/useuse_automation_templateCreate a draft automation from a template or set
GET /eventslist_eventsList what contacts did, newest first
GET /events/nameslist_event_namesList the kinds of event recorded in the last 30 days
POST /events/previewno expuestoThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connectionslist_connectionsList the workspace's connections (incoming webhooks)
POST /connectionscreate_connectionCreate a connection and get its address
POST /connections/testno expuestoThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connections/:idget_connectionRetrieve a connection with its last deliveries
PATCH /connections/:idupdate_connectionChange a connection or switch it on or off
DELETE /connections/:iddelete_connectionDelete a connection
POST /connections/:id/addressno expuestoThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
GET /accountget_accountObtener la cuenta, el uso, el estado de facturación y los recuentos del espacio de trabajo con una clave de API
GET /account/diagnosticsget_account_diagnosticsDiagnose sending and receiving problems in the workspace
GET /analyticsget_analyticsObtener las analíticas de envío del panel de 7, 30 o 90 días
GET /profileget_accountGemelo de GET /account solo para sesiones; el servidor MCP lee la ruta con clave de API.
POST /billing/checkoutno expuestoPor diseño, los cambios de facturación solo se hacen con sesión y requieren al propietario de la cuenta en el panel. El estado de facturación se puede leer con get_account.
POST /billing/cancelno expuestoPor diseño, los cambios de facturación solo se hacen con sesión y requieren al propietario de la cuenta en el panel. El estado de facturación se puede leer con get_account.
POST /keysno expuestoExcluido deliberadamente: un agente no debe emitir ni destruir credenciales. Las claves las gestiona una persona en el panel.
GET /keyslist_api_keysListar los metadatos de las claves de API
DELETE /keys/:idno expuestoExcluido deliberadamente: un agente no debe emitir ni destruir credenciales. Las claves las gestiona una persona en el panel.

No disponible deliberadamente

CapacidadEndpointsMotivo
Crear, rotar, revocar o eliminar claves de APIPOST /keys, DELETE /keys/:idExcluido deliberadamente: un agente no debe emitir ni destruir credenciales. Las claves las gestiona una persona en el panel.
Iniciar una página de pago o cancelar una suscripciónPOST /billing/checkout, POST /billing/cancelPor diseño, los cambios de facturación solo se hacen con sesión y requieren al propietario de la cuenta en el panel. El estado de facturación se puede leer con get_account.
DNS con un clic de Cloudflare (OAuth)GET /api/dns/cloudflare/connectRequiere una sesión interactiva del navegador y el consentimiento OAuth de Cloudflare. En su lugar, use los registros de get_domain, los hosts de get_dns_provider o get_domain_connect_link.
Registro, inicio de sesión, cierre de sesión, vinculación de cuenta de Google/api/auth/*Autenticación humana en el navegador; el servidor MCP se autentica con una clave de API.
Formulario de contacto con soportePOST /api/contactFormulario público del sitio de marketing para personas, no una operación del espacio de trabajo.
Webhook endpoints and deliveriesGET /webhooks, POST /webhooks, GET /webhooks/:id, PATCH /webhooks/:id, DELETE /webhooks/:id, POST /webhooks/:id/rotate-secret, POST /webhooks/:id/test, GET /webhooks/:id/deliveries, GET /webhooks/:id/deliveries/:deliveryId, POST /webhooks/:id/deliveries/:deliveryId/retryWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
Upload editor images and export contacts as CSVPOST /uploads/images, GET /contacts/exportImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
Import an automation's send history and record events in bulkPOST /automations/:key/import-history, POST /events/batchHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
Move SendHQ's own win-back emails onto automations (backfill and comparison)POST /automations/platform-backfill, GET /automations/platform-compareInternal cutover tools for SendHQ's own workspace only: they answer nobody else, need its owner's dashboard session, and are not part of the public API or of /api/v1. The backfill enrols SendHQ's own accounts, so it is run by a person, one page at a time, after reading the dry run.
Replace a connection's secret addressPOST /connections/:id/addressThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
Dry runs for a sample payload and for a set of eventsPOST /connections/test, POST /events/previewThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.

Catálogo legible por máquinas: /docs/mcp/tools.json (esquemas, anotaciones, correspondencia con endpoints, exclusiones). Versión Markdown de esta página: /docs/mcp.md. Con la CLI instalada, sendhq commands --format json imprime el mismo catálogo.