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.
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcpQué 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
codeestable, elstatusHTTP, unaexplanation, unremedyconcreto 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-onlyoculta 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.
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
- Abra Settings → Connectors y busque SendHQ en el directorio, o elija Add custom connector y pegue
https://mcp.sendhq.cc/mcp. - Haga clic en Connect, inicie sesión en SendHQ, revise el acceso y haga clic en Allow.
- 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
- Open Settings → Security and login and turn on Developer mode.
- Go to chatgpt.com/plugins, click Create MCP app, name it SendHQ and enter
https://mcp.sendhq.cc/mcp. - Sign in to SendHQ and click Allow, then pick SendHQ from the tools menu in a new chat.
Grok
- Go to grok.com/connectors, click New Connector, then Custom.
- Enter
https://mcp.sendhq.cc/mcp, sign in to SendHQ and click Allow.
Muse by Meta
In Muse, open Connectors and search for SendHQ. Click Connect, sign in to SendHQ and click Allow.
Aprobación y desconexión
- The
request_featuretool 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.
curl -fsSL https://downloads.sendhq.cc/install.sh | shirm https://downloads.sendhq.cc/install.ps1 | iexsendhq version
SENDHQ_API_KEY=re_your_key sendhq doctorCree 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:
SENDHQ_API_KEY=re_your_key sendhq mcpNormalmente 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 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-onlyAgregue --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.
{
"mcpServers": {
"sendhq": {
"command": "sendhq",
"args": [
"mcp"
],
"env": {
"SENDHQ_API_KEY": "${SENDHQ_API_KEY}"
}
}
}
}OpenAI Codex
[mcp_servers.sendhq]
command = "sendhq"
args = ["mcp"]
env = { SENDHQ_API_KEY = "re_your_key" }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).
{
"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.
{"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 flag | Obligatoria | Significado |
|---|---|---|
SENDHQ_API_KEY | sí | 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_URL | no | URL 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_ONLY | no | 1, true o yes se comporta como --read-only. |
--read-only | no | Expone 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 / --profile | no | Usa 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), andsend_broadcast_to_moredeliver mail to real people and consume delivery credits. Their descriptions start withSENDS REAL EMAIL. Call them only when the user explicitly asked for that specific message to be sent, with the recipients, sender, and content confirmed. - Destructive.
delete_email,delete_draft,delete_attachment,delete_domain,delete_inbox,remove_suppression, the campaign deletes (delete_contact,delete_list,remove_list_contact,delete_broadcast,cancel_broadcast,delete_segment,delete_contact_field), andbulk_update_contactsare markeddestructiveHint: trueand their descriptions start withDESTRUCTIVE. Confirm with the user first.remove_suppressionweakens a safety block and is appropriate only when a human confirms the address works again. - 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: truey se puede llamar libremente. - Este servidor nunca modifica el DNS.
add_domaindevuelve registros para que una persona los publique;get_domain_connect_linkdevuelve una URL de consentimiento que una persona debe abrir y aprobar en su proveedor de DNS. - Este servidor nunca modifica la facturación.
get_accountsolo 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 (machineinget_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
get_service_healthconfirma que la API es accesible (funciona sin clave).get_accountshows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returnssubscription_required.list_sending_identitiesenumera las direcciones From que puede usar. Si está vacía, complete primero el flujo de dominio.- Confirme con el usuario el remitente, el destinatario, el asunto y el cuerpo; después llame a
send_emailcon unaidempotency_key. list_email_eventscon eliddevuelto muestradelivery,bounce,complaintorejecten cuanto el proveedor lo notifica (normalmente entre unos segundos y unos minutos).
{
"name": "send_email",
"arguments": {
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"subject": "SendHQ is connected",
"text": "It works.",
"idempotency_key": "first-send-2026-09-26"
}
}2. Verificación de dominios de principio a fin
add_domainwithname: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).get_dns_providercon eldomain_iddetecta el proveedor de DNS autoritativo y devuelve el host relativo exacto que hay que introducir para cada registro en ese proveedor.- If
providers.domainConnect.availableis true,get_domain_connect_linkreturns a consent URL. Give it to the human; nothing changes until they approve at the provider. Otherwise, give the human the records to publish. Never publish a second SPF record: merge SendHQ's SPF include (include:amazonses.com) into the existingv=spf1value. verify_domainrechecks DNS and DKIM verification. Status moves throughpending,checking, andpropagatingtoverified. Pollverify_domainorget_domainevery 30–60 seconds; DNS can take minutes to hours.- Cuando
statusesverified, las direcciones del dominio aparecen enlist_sending_identities.
3. Rebotes, quejas y supresiones
list_blocked_recipientsdevuelve todas las direcciones bloqueadas con su motivo (bounce,complaint,unsubscribe) y un recuento resumido.list_suppressionsdevuelve las supresiones por rebote permanente y por queja;deliverability_statsofrece las tasas de entrega, rebotes y quejas de 30 días;list_sender_reputationmuestra qué direcciones From tienen el envío limitado o en pausa.- Un envío que contiene un destinatario suprimido falla con
422 recipient_suppressed. Quite ese destinatario y vuelva a enviar. - Llame a
remove_suppressionsolo 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
- El dominio (a menudo un subdominio como
inbound.example.com) debe estar verificado. setup_inboundhabilita la recepción y devuelve un registro MX. Una persona lo publica.verify_inboundhasta questatusseaready.create_inboxcondomain_idylocal_part(por ejemplo,support) creasupport@inbound.example.com.- Consulte periódicamente
list_emailscondirection: "in"yunread: true(opcionalmenteinbox_id). Lea un mensaje conget_email, su conversación conget_thready los adjuntos condownload_attachment, y márquelo como atendido conmark_email(read: true). - Responda dentro del hilo con
send_emailyreply_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
- Localice el mensaje:
list_emailscondirection: "out"ytooquery, oget_emailsi tiene el ID.status: failedsignifica que SendHQ o el proveedor lo rechazó en el envío; el error del correo explica el motivo. list_email_events:bounce(permanente o transitorio, con el diagnóstico del proveedor),complaint,rejectodelivery. Si aún no hay eventos, el proveedor no ha informado; espere y vuelva a comprobar.- If the send call itself failed, read the error
code:subscription_required→ the owner activates a plan;sender_domain_unverified→ finish domain verification;recipient_suppressed→ the address hard-bounced or complained before;sender_paused→ inspectlist_sender_reputation;account_paused→ the workspace is paused for review, read the rates;daily_limit_reached→ wait until midnight UTC;quota_exhausted→get_accountusage. get_domaincomprueba que DKIM, SPF y DMARC siguen publicados;deliverability_statsmuestra si el problema es de un solo mensaje o una tendencia.- Informe lo que muestran las evidencias. Un evento
deliverysignifica 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)
create_labelconname(por ejemplo,Agent/Orders) yskip_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.- Envíe el correo de la tarea con
send_email(osend_batch) ylabels: ["Agent/Orders"]. Las respuestas a esa conversación heredan la etiqueta automáticamente y no pasan por la bandeja de entrada. - Para el correo que empieza fuera de sus conversaciones, agregue una regla de archivado:
create_label_ruleconinbox_id(una dirección dedicada comoorders@…),from,toosubject. Paseapply_to_existing: truepara archivar el correo ya recibido. - Trabaje la categoría:
list_emailsconlabel: "Agent/Orders",direction: "in"yunread: true; lea conget_emailoget_thread, responda consend_emailyreply_to_email_id, y usemark_emailread: truecuando lo haya atendido. - 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. - Opcionalmente,
set_inbox_forwardingenví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).
{
"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
- Audience:
list_lists(orcreate_listwith a signup form), and optionallypreview_segmentthencreate_segmentto narrow it, for example to contacts taggedVIPwho opened in the last 90 days. Add only people who asked for your email: every subscribed contact needs aconsent_basis. get_newsletter_settings: ifpostalAddressis empty, ask the user for one and set it withupdate_newsletter_settings(marketing email needs it).create_broadcastwithlist_id, a verifiedfrom,subject,preview_text, content (markdownis simplest), and optionallyaudience(segment_id,limit,order: engaged).check_broadcast: fix everyblockitem and tell the user aboutwarnitems. Thensend_broadcast_testto the user's own address so they can look at it.- Only when the user says to send:
send_broadcastnow (with anidempotency_key), orschedule_broadcastwithscheduled_at(unschedule_broadcastto change it). - Follow up with
get_broadcast(delivery totals),get_broadcast_report(opens, clicks, links, inbox providers, against your average), andlist_broadcast_recipientswithactivity. Report opens as estimates. With a limited audience,send_broadcast_to_moresends to the next people.
{
"name": "create_broadcast",
"arguments": {
"list_id": "lst_…",
"from": "Acme <news@example.com>",
"subject": "What shipped in October",
"preview_text": "Three new features",
"markdown": "Hi {{first_name | there}},\n\nHere is what shipped this month.",
"audience": {
"segment_id": "seg_…"
}
}
}10. Run an automation
An automation is a timed sequence of emails that starts when a contact does something and stops when they convert. Automations are being enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled from every tool below.
create_automationwith akey, theentryevent,exit_rules(thegoal_eventthat counts as converting, orno_goal: true), a verifiedfrom_address, andsteps, each dueoffset_secondsafter the person entered. It starts as a draft and sends nothing. Every automation carriesdomain, the domain of itsfrom_address; in a workspace that sends from several domains,list_automationsandget_automations_overviewtakedomainto show the automations of one of them.- To let the user read it first:
send_automation_test_emailsends one email, andsend_automation_testevery email in order, to the account's own address only (never to a contact), with stand-in values for the merge tags. A test enrols nobody, is in no report, and works while the automation is still a draft. Both send real email, so only when the user asks.send_automation_test_emailwithdry_run: truereturns the rendered email without sending anything. get_sending_limitsshows how much automation email one person may get across every automation, and during which hours. Change them withupdate_sending_limitsonly when the user asks.- To start from a ready-made email instead of writing one:
list_automation_templatesis the template library (welcome, onboarding tips, a nudge to finish setup, trial ending and trial ended, abandoned checkout, failed payment or dunning, receipt, upgrade at a usage limit, feature announcement, review request, feedback score, cancellation survey, and winback for retention),get_automation_templateshows one with the email as this workspace would send it, anduse_automation_templatemakes the draft automation with the emails, the suggested entry event and the suggested goal. Some templates come as a set that makes one automation: three onboarding tips, trial ending then trial ended, payment failed then a last notice.set_automation_stepwithtemplateloads one template into an email of an automation that already exists. - An email can also be built in the dashboard's drag-and-drop builder.
get_automationshows such an email witheditordesign: itscontentis the builder's project, which only the builder writes, and itshtmlis what is sent. Leave the project alone. To change the wording of a designed email, ask the user to open it in the dashboard; to replace it, send your ownhtmlwitheditorhtml. - A template is finished except for what only the user knows, written as placeholders in square brackets:
[First step], or[Link to plans]as a link's address.to_fillon the automation lists each one by email, and each workspace name the emails print that is blank. Ask the user for the real words and links, write them in withset_automation_step, and setproduct_nameandsender_namewithupdate_sending_limits. Never invent them.set_automation_statusrefuses to turn the automation on while anything is left (422automation_not_ready, with aproblemslist that names each email and detail); test emails are allowed, so the user can read it first. - Only when the user says to start:
set_automation_statuswithstatus: "on". - Record what people do with
track_event(a new contact needscontact.consent_basis). The entry event starts the sequence, the goal event ends it as converted, and adedupe_keymakes a retry harmless.enroll_contactandexit_contactadd or remove one person by hand. preview_automationshows, for everyone in the automation now, which email would go out if they were evaluated at this moment, or why not: nothing due until a time, held by a limit or the sending hours until a time, waiting behind a higher-priority automation, or skipped. It sends nothing and changes nothing.list_automationsgives each automation's 30-day totals. An email that a limit holds back is not dropped: it goes out when the limit allows. When several emails of one automation are due at once, only the latest is sent.- Results:
get_automations_overview(every automation) andget_automation_report(one automation, with a row per email) give totals and a number for each day of a date range: people who entered, emails sent, delivered, opened, clicked, and converted.list_automation_peoplelists who did what (did: entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, or waiting), andget_automation_persongives one contact's history with every open and click. Automation emails are tracked like broadcasts: report opens and clicks as estimates, and note that automated requests are labelledmachineand never counted.
{
"name": "use_automation_template",
"arguments": {
"template_id": "payment-failed-notices",
"from_name": "Dana from Acme",
"from_address": "dana@example.com"
}
}{
"name": "preview_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}{
"name": "list_automation_people",
"arguments": {
"automation_key": "checkout-recovery",
"did": "clicked",
"step": 1
}
}11. See what came in, and connect another system
Events reach SendHQ three ways: track_event from the workspace's own code, a connection (a secret address a payment provider or another system posts its webhooks to), and a spreadsheet uploaded in the dashboard. See /docs/events.
list_eventsis the feed of everything recorded, newest first: who, what they did (also as plain words), when, where it came from, and which automations it started, ended, or converted. Filter bycontact, byname, or by date.list_event_nameslists the kinds of event seen in the last 30 days.list_connectionsshows each connection with its last delivery in plain words, andget_connectionits last 50 deliveries: "Recorded 2 events", "Skipped: no email address", "Refused: bad signature". Start there when something a provider sent did not show up.- Only when the user asks to connect a system:
create_connectionwithkindstripeordodo(mapped for you) orgenericwith amapping. It returns the secretaddressonce; give it to the user to paste into that system. From then on what arrives is recorded without anyone looking, and can start automations that send email. update_connectionwithenabled: falsepauses a connection (its address answers 404);delete_connectionremoves it. The provider's signing secret and a replacement address are set by a person in the dashboard.
{
"name": "list_events",
"arguments": {
"contact": "ada@example.net"
}
}12. Check an email's content before it is sent
score_email reads a subject, the HTML and the plain text as they were written and returns a score from 0 to 100 with what to change, most points first. A plain email with no links and no images scores 100; a designed layout, links to another site than the sender's, link shorteners, images with few words, hidden text, capitals and very long HTML each take points off. Pass from so links can be compared with the sender's own domain. Nothing is stored or sent, and the footer and tracking SendHQ adds are not scored. The dashboard's email editor shows the same number for the same content. It looks at content only, so use it as a checklist: sender reputation, authentication and how recipients react decide more of where mail lands.
{
"name": "score_email",
"arguments": {
"from": "hello@example.com",
"subject": "Your cart is still here",
"html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
}
}Resultados, 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.
{
"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": {
"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: trueyretryable: false. Reviselist_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_emailconattachmentsen línea no admite unaidempotency_key, porque ejecuta varias solicitudes. Para envíos con adjuntos seguros ante reintentos:create_draft→upload_attachment→send_emailcondraft_ideidempotency_key.
{
"name": "send_email",
"arguments": {
"from": "Acme <billing@example.com>",
"to": [
"owner@example.com"
],
"subject": "Receipt #4812",
"text": "Thanks for your payment.",
"idempotency_key": "receipt-4812"
}
}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.recipientDeliveriesfrente ausage.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_requireduntil a paid plan is active. There is no free or trial allowance. - Workspace daily ladder on paid plans: 1,000 recipients on day one, then 2,000, 3,000, 5,000, 8,000, 12,000, 18,000, 25,000, 35,000, 45,000, and 50,000. A step is gained after a UTC day that used at least half the cap with healthy 7-day feedback. A high rate demotes once per incident, not every day the rate stays high. See
get_account→sendingLimit. Over the cap:daily_limit_reached, not queued, retry afterresets_at(midnight UTC), not on a short backoff. - Hourly pace: about one tenth of the day's cap each UTC hour (100 on day one).
hourly_limit_reachedwaits until the next UTC hour. - New domains: a sending domain less than 30 days old may send at most 500 Gmail recipients a day (
gmail_recipient_limit), on any ladder rung.gmail_rate_limitedmeans Gmail returned 4.7.28; wait untilresets_atand keep sending to other providers. - 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_batchhasta 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.
| code | HTTP | ¿Reintentar? | Qué significa y qué hacer |
|---|---|---|---|
invalid_arguments | — | no | Los argumentos no superaron localmente el JSON Schema de la herramienta; nada llegó a SendHQ. Corrija los campos indicados en problems. |
auth_error | 401 | no | Clave 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_required | 402 | no | No active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then. |
payment_required | 402 | no | La función requiere un plan de pago (por ejemplo, los adjuntos). Envíe sin ella o cambie a un plan superior. |
sender_domain_not_owned | 403 | no | El dominio From no pertenece a este espacio de trabajo. Use list_sending_identities o add_domain. |
sender_domain_unverified | 403 | no | El dominio From aún no está verificado. get_domain, publique los registros que faltan, verify_domain. |
domain_limit_reached | 403 | no | Se alcanzó el límite de dominios del plan. Elimine un dominio sin uso (con aprobación) o cambie a un plan superior. |
marketing_not_enabled | 403 | no | La clase marketing no está habilitada para este dominio o plan. Use transactional solo si el mensaje realmente lo es. |
forbidden | 403 | no | La política no permite la operación. Ajuste la solicitud. |
not_found | 404 | no | El ID no pertenece a este espacio de trabajo. Liste el recurso para encontrar el ID correcto; restaure primero las plantillas archivadas. |
idempotency_conflict | 409 | no | Clave reutilizada con un cuerpo distinto. Reenvíe exactamente el original o use una clave nueva para un mensaje nuevo. |
idempotency_in_progress | 409 | sí | La solicitud original sigue en curso. Espere y reintente con la misma clave y el mismo cuerpo. |
revision_conflict | 409 | no | El borrador de la plantilla cambió desde que lo leyó. get_template, combine los cambios y vuelva a guardar. |
complaint_suppression_locked | 409 | no | El destinatario presentó una queja. No vuelva a escribirle nunca. |
inbound_not_ready | 409 | no | La recepción de correo entrante no está lista. setup_inbound, publique el MX, verify_inbound. |
conflict | 409 | no | El recurso ya existe o está en un estado incorrecto. Léalo y ajústelo. |
attachments_too_large | 413 | no | Más de 10 archivos o 10 MB. Quite adjuntos o reduzca su tamaño. |
recipient_suppressed | 422 | no | Un destinatario tuvo antes un rebote permanente o presentó una queja. Quítelo; consulte list_blocked_recipients. |
recipient_unsubscribed | 422 | no | Un destinatario se dio de baja del correo de marketing. Quítelo de forma permanente. |
validation_failed | 422 | no | Contenido rechazado, por ejemplo datos de plantilla que incumplen el contrato de variables. Corrija la entrada. |
sender_paused | 423 | no | Esta 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_paused | 423 | no | Workspace paused for a deliverability review. The body has the measured rate and the limit when the pause was for bounces or complaints. Do not send until it is restored. |
quota_exhausted | 429 | no | Monthly allowance, per-sender daily limit, or attachment transfer. Not the workspace daily ladder. Check get_account; wait for that limit to reset or upgrade. |
daily_limit_reached | 429 | after reset | Workspace daily ladder. Not a short backoff. Wait until resets_at (midnight UTC). The message was not queued. |
hourly_limit_reached | 429 | after reset | Hourly pace (about a tenth of the day's cap). Wait until the next UTC hour. Not a short backoff. |
gmail_recipient_limit | 429 | after reset | 500 Gmail recipients a day for a sending domain under 30 days old, on any ladder rung. Wait until midnight UTC. Not queued. |
gmail_rate_limited | 429 | after reset | Gmail returned 4.7.28 for this domain. Wait until resets_at. Other providers keep sending. |
rate_limited | 429 | sí | Slow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap. |
server_error | 5xx | sí | 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_request | 400 | no | Solicitud mal formada. Lea message y corríjala. |
tool_error | — | no | Fallo 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
Ninguna herramienta coincide con este filtro.
Correos e hilos
send_emailEnviar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
from | string | sí | 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) |
to | string[] | 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) |
cc | string[] | no | Destinatarios en copia. (0–100 elementos) |
bcc | string[] | no | Destinatarios en copia oculta. (0–100 elementos) |
subject | string | no | Línea de asunto. Omítala al enviar una plantilla. (máx. 998 caracteres) |
text | string | no | Cuerpo en texto sin formato. Proporcione text, html o template. |
html | string | no | Cuerpo HTML. SendHQ lo sanea y genera el texto cuando se omite text. |
reply_to | string | no | Dirección Reply-To. |
headers | object | no | Encabezados 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_class | string | no | transactional (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_id | string | no | Responder 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_id | string | no | ID de hilo explícito en el que archivar el mensaje. |
draft_id | string | no | Enviar con este mensaje los adjuntos de un borrador guardado (dr_…). El borrador se elimina tras un envío correcto. |
template | object | no | Enviar 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.id | string | no | ID de la plantilla (tmpl_…). Proporcione id o key. |
template.key | string | no | Clave de la plantilla, como account-welcome. Proporcione id o key. |
template.version_id | string | no | ID de versión publicada opcional (tmplv_…). Por defecto, la versión publicada actual. |
template.data | object | no | Valores para las variables tipadas de la plantilla. |
labels | string[] | no | Nombres 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_key | string | no | Encabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres) |
attachments | object[] | no | Archivos 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[].filename | string | no | Nombre de archivo que ve el destinatario. Obligatorio con content_base64; por defecto, el nombre base de file_path. (máx. 255 caracteres) |
attachments[].content_type | string | no | Tipo MIME, p. ej. application/pdf. Por defecto, application/octet-stream. |
attachments[].content_base64 | string | no | Contenido del archivo en base64 estándar. |
attachments[].file_path | string | no | Ruta absoluta de un archivo local que el proceso del servidor MCP pueda leer. |
{
"name": "send_email",
"arguments": {
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"subject": "Your export is ready",
"text": "Download it from your dashboard.",
"idempotency_key": "export-ready-42"
}
}send_batchEnviar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
emails | object[] | sí | Mensajes que enviar. (1–100 elementos) Proporcione al menos uno de: html, text, template. |
idempotency_key | string | no | Idempotency-Key para todo el lote (máx. 200 caracteres). (máx. 200 caracteres) |
{
"name": "send_batch",
"arguments": {
"emails": [
{
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"template": {
"key": "account-welcome",
"data": {
"first_name": "Asha"
}
}
}
],
"idempotency_key": "welcome-batch-2026-09-26"
}
}list_emailsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
direction | string | no | in para el recibido, out para el enviado. (uno de in, out) |
status | string | no | Filtro de estado, p. ej. queued, sent, delivered, bounced, complained, failed. |
domain | string | no | Solo los mensajes de este dominio, o de una lista de dominios separados por comas (coincide con cualquiera). |
inbox_id | string | no | Solo los mensajes recibidos en esta bandeja de entrada (inb_…). |
label | string | no | Solo 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. |
archived | boolean | no | false = la vista de la bandeja de entrada (correo recibido no archivado), true = solo archivados. Omítalo para todo el correo. |
category | string | no | primary (personas), updates (newsletters, envíos masivos, automatizados) o spam; o una lista separada por comas. El spam se oculta salvo que se solicite. |
important | boolean | no | true = solo los mensajes marcados como importantes (respuestas a conversaciones que usted inició y remitentes marcados como importantes). |
include_spam | boolean | no | Incluir el spam en los resultados (para búsquedas en todas las carpetas). |
from | string | no | La dirección del remitente contiene este valor. |
to | string | no | La dirección del destinatario contiene este valor. |
unread | boolean | no | true = solo no leídos, false = solo leídos. |
after | string | no | Marca de tiempo ISO-8601; solo los mensajes creados después de ella. (date-time) |
before | string | no | Marca de tiempo ISO-8601; solo los mensajes creados antes de ella. (date-time) |
query | string | no | Búsqueda de texto libre en asuntos, cuerpos, direcciones de remitente/destinatario y nombres de archivos adjuntos. (máx. 200 caracteres) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_emails",
"arguments": {
"direction": "in",
"unread": true,
"limit": 25
}
}get_emailObtener 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | ID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "get_email",
"arguments": {
"email_id": "em_123"
}
}mark_emailMarcar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | ID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
read | boolean | no | true = leído, false = no leído. |
archived | boolean | no | true = archivar (fuera de la bandeja de entrada), false = devolver a la bandeja de entrada. |
category | string | no | Mueve un mensaje recibido a primary, updates o spam. (uno de primary, updates, spam) |
important | boolean | no | Marca o desmarca el mensaje como importante. |
learn | boolean | no | false = no recordar este veredicto para el remitente (predeterminado true). |
{
"name": "mark_email",
"arguments": {
"email_id": "em_123",
"read": true
}
}delete_emailEliminar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | ID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "delete_email",
"arguments": {
"email_id": "em_123"
}
}list_email_eventsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | ID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_email_events",
"arguments": {
"email_id": "em_123"
}
}get_threadObtener 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
thread_id | string | sí | ID del hilo (normalmente el ID em_… del primer mensaje; consulte threadId en cualquier correo). (máx. 128 caracteres) |
{
"name": "get_thread",
"arguments": {
"thread_id": "em_123"
}
}email_deliveryGet an email delivery timeline
Queued, sent, delivered, delayed, bounced, complained, and failed events for one email, with bounce type and the SMTP diagnostic. Reasons are plain text.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | |
limit | integer | no | |
offset | integer | no |
{
"name": "email_delivery",
"arguments": {
"email_id": "em_123"
}
}thread_deliveryGet a thread delivery summary
Counts of delivered, bounced, complained, and failed outbound messages in one conversation, plus each message's failure reason.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
thread_id | string | sí |
{
"name": "thread_delivery",
"arguments": {
"thread_id": "thr_123"
}
}Etiquetas y reglas de archivado automático
list_labelsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_labels",
"arguments": {}
}get_labelObtener una etiqueta
Recupera una etiqueta con sus recuentos y reglas de archivado automático.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
label_id | string | sí | ID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres) |
{
"name": "get_label",
"arguments": {
"label_id": "Billing"
}
}create_labelCrear 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | 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) |
color | string | no | Color hexadecimal, como #1a73e8. Opcional. |
skip_inbox | boolean | no | Modo 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. |
rules | object[] | no | Reglas de archivado automático opcionales (máx. 20). Cada una necesita al menos uno de inbox_id, from, to, subject. (0–20 elementos) |
rules[].direction | string | no | Solo el correo in (recibido) u out (enviado). Omítalo para ambos. (uno de in, out) |
rules[].inbox_id | string | no | Solo el correo recibido en esta bandeja de entrada (inb_…). Archiva cada dirección de recepción en su propia carpeta. |
rules[].from | string | no | El remitente contiene este texto (sin distinguir mayúsculas y minúsculas), p. ej. @stripe.com. (máx. 200 caracteres) |
rules[].to | string | no | To/Cc contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres) |
rules[].subject | string | no | El asunto contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres) |
rules[].skip_inbox | boolean | no | Archivar el correo recibido que coincida para que aparezca solo en la carpeta de la etiqueta, no en la bandeja de entrada. |
apply_to_existing | boolean | no | Archivar también el correo ya conservado que coincida con las reglas. |
{
"name": "create_label",
"arguments": {
"name": "Agent/Orders",
"skip_inbox": true,
"rules": [
{
"from": "@stripe.com"
}
]
}
}update_labelRenombrar, 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
label_id | string | sí | ID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres) |
name | string | no | Nombre nuevo. (máx. 64 caracteres) |
color | string | no | Color hexadecimal nuevo. |
skip_inbox | boolean | no | Modo 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. |
{
"name": "update_label",
"arguments": {
"label_id": "lbl_123",
"name": "Finance/Billing"
}
}delete_labelEliminar una etiqueta
DESTRUCTIVE: elimina una etiqueta y sus reglas. El correo en sí se conserva; solo pierde esta etiqueta.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
label_id | string | sí | ID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres) |
{
"name": "delete_label",
"arguments": {
"label_id": "lbl_123"
}
}create_label_ruleAgregar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
label_id | string | sí | ID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres) |
direction | string | no | Solo el correo in (recibido) u out (enviado). Omítalo para ambos. (uno de in, out) |
inbox_id | string | no | Solo el correo recibido en esta bandeja de entrada (inb_…). Archiva cada dirección de recepción en su propia carpeta. |
from | string | no | El remitente contiene este texto (sin distinguir mayúsculas y minúsculas), p. ej. @stripe.com. (máx. 200 caracteres) |
to | string | no | To/Cc contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres) |
subject | string | no | El asunto contiene este texto (sin distinguir mayúsculas y minúsculas). (máx. 200 caracteres) |
skip_inbox | boolean | no | Archivar el correo recibido que coincida para que aparezca solo en la carpeta de la etiqueta, no en la bandeja de entrada. |
apply_to_existing | boolean | no | Archivar también el correo ya conservado que coincida. |
{
"name": "create_label_rule",
"arguments": {
"label_id": "Billing",
"inbox_id": "inb_123",
"skip_inbox": true
}
}delete_label_ruleEliminar una regla de archivado automático
DESTRUCTIVE: elimina una regla de archivado automático. El correo ya archivado conserva su etiqueta.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
label_id | string | sí | ID de la etiqueta (empieza por lbl_) o el nombre exacto de la etiqueta. (máx. 128 caracteres) |
rule_id | string | sí | ID de la regla (empieza por lrule_), obtenido de get_label. (máx. 128 caracteres) |
{
"name": "delete_label_rule",
"arguments": {
"label_id": "lbl_123",
"rule_id": "lrule_123"
}
}label_emailAgregar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email_id | string | sí | ID del correo (empieza por em_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
add | string[] | no | Etiquetas que agregar. (0–10 elementos) |
remove | string[] | no | Etiquetas que quitar. (0–10 elementos) |
create | boolean | no | Crear las etiquetas desconocidas en add (predeterminado true). |
{
"name": "label_email",
"arguments": {
"email_id": "em_123",
"add": [
"Billing"
],
"remove": [
"Support"
]
}
}Borradores, adjuntos e identidades de remitente
list_sending_identitiesListar 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.
{
"name": "list_sending_identities",
"arguments": {}
}create_draftCrear 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
from | string | no | Dirección del remitente en un dominio verificado (puede estar vacía mientras se redacta). |
to | string[] | no | Destinatarios. (0–100 elementos) |
cc | string[] | no | Destinatarios en copia. (0–100 elementos) |
bcc | string[] | no | Destinatarios en copia oculta. (0–100 elementos) |
subject | string | no | Línea de asunto. (máx. 998 caracteres) |
html | string | no | Cuerpo HTML. |
text | string | no | Cuerpo en texto sin formato. |
reply_to_email_id | string | no | ID del correo al que responde este borrador. |
thread_id | string | no | ID del hilo al que pertenece este borrador. |
{
"name": "create_draft",
"arguments": {
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice"
}
}list_draftsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_drafts",
"arguments": {}
}get_draftObtener un borrador
Recupera un borrador con los metadatos de sus adjuntos.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
draft_id | string | sí | ID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "get_draft",
"arguments": {
"draft_id": "dr_123"
}
}update_draftReemplazar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
draft_id | string | sí | ID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
from | string | no | Dirección del remitente en un dominio verificado (puede estar vacía mientras se redacta). |
to | string[] | no | Destinatarios. (0–100 elementos) |
cc | string[] | no | Destinatarios en copia. (0–100 elementos) |
bcc | string[] | no | Destinatarios en copia oculta. (0–100 elementos) |
subject | string | no | Línea de asunto. (máx. 998 caracteres) |
html | string | no | Cuerpo HTML. |
text | string | no | Cuerpo en texto sin formato. |
reply_to_email_id | string | no | ID del correo al que responde este borrador. |
thread_id | string | no | ID del hilo al que pertenece este borrador. |
{
"name": "update_draft",
"arguments": {
"draft_id": "dr_123",
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice (updated)",
"text": "Attached."
}
}delete_draftDescartar un borrador
DESTRUCTIVE: descarta un borrador y elimina de forma permanente sus adjuntos almacenados.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
draft_id | string | sí | ID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "delete_draft",
"arguments": {
"draft_id": "dr_123"
}
}upload_attachmentSubir 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
draft_id | string | sí | ID del borrador (empieza por dr_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
filename | string | no | Nombre de archivo que ve el destinatario. Por defecto, el nombre base de file_path. (máx. 255 caracteres) |
content_type | string | no | Tipo MIME, p. ej. application/pdf. Por defecto, application/octet-stream. |
content_base64 | string | no | Contenido del archivo en base64 estándar. |
file_path | string | no | Ruta absoluta de un archivo local que el proceso del servidor MCP pueda leer. |
{
"name": "upload_attachment",
"arguments": {
"draft_id": "dr_123",
"filename": "invoice.pdf",
"content_type": "application/pdf",
"file_path": "/tmp/invoice.pdf"
}
}download_attachmentDescargar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
attachment_id | string | sí | ID del adjunto (empieza por att_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
save_to_path | string | no | Ruta local absoluta opcional en la que escribir el archivo en lugar de devolverlo en base64. |
overwrite | boolean | no | Permite reemplazar un archivo existente en save_to_path. Por defecto, false. |
{
"name": "download_attachment",
"arguments": {
"attachment_id": "att_123",
"save_to_path": "/tmp/invoice.pdf"
}
}delete_attachmentEliminar un adjunto
DESTRUCTIVE: elimina de forma permanente un adjunto almacenado (por ejemplo, para quitar un archivo de un borrador antes de enviarlo).
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
attachment_id | string | sí | ID del adjunto (empieza por att_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "delete_attachment",
"arguments": {
"attachment_id": "att_123"
}
}Plantillas alojadas
list_templatesListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
lifecycle | string | no | active (predeterminado), archived o all. (uno de active, archived, all) |
query | string | no | Buscar por nombre o clave. (máx. 120 caracteres) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_templates",
"arguments": {
"lifecycle": "active"
}
}create_templateCrear 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | Nombre legible. (máx. 120 caracteres) |
key | string | no | Clave 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. |
starter | string | no | Contenido inicial. (uno de blank, welcome, reset, receipt) |
{
"name": "create_template",
"arguments": {
"name": "Account welcome",
"key": "account-welcome",
"starter": "welcome"
}
}get_templateObtener 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID de la plantilla (tmpl_…) o clave. (máx. 128 caracteres) |
{
"name": "get_template",
"arguments": {
"template_id": "account-welcome"
}
}update_template_draftGuardar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
revision | integer | sí | Revisión actual del borrador, obtenida de get_template. (1–…) |
name | string | no | Nombre de la plantilla. (máx. 120 caracteres) |
subject_template | string | no | Asunto con marcadores. (máx. 998 caracteres) |
preheader_template | string | no | Texto de vista previa. (máx. 240 caracteres) |
html_template | string | no | Cuerpo HTML con marcadores. |
text_template | string | no | Cuerpo en texto sin formato con marcadores. |
from | string | no | Remitente predeterminado para los envíos de esta plantilla. |
reply_to | string | no | Reply-To predeterminado. |
variables | object[] | no | Contrato de variables tipadas. Cada elemento: {key (minúsculas/guiones bajos), label, type: text|number|url|boolean, required (predeterminado true), fallback, description}. |
variables[].key | string | sí | |
variables[].label | string | no | |
variables[].type | string | no | (uno de text, number, url, boolean) |
variables[].required | boolean | no | |
variables[].fallback | any | no | |
variables[].description | string | no | |
sample_data | object | no | Valores de ejemplo usados en vistas previas y pruebas. |
{
"name": "update_template_draft",
"arguments": {
"template_id": "account-welcome",
"revision": 3,
"name": "Account welcome",
"subject_template": "Welcome, {{first_name}}",
"text_template": "Hi {{first_name}}",
"variables": [
{
"key": "first_name",
"type": "text",
"required": true
}
],
"sample_data": {
"first_name": "Asha"
}
}
}create_template_draftIniciar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
{
"name": "create_template_draft",
"arguments": {
"template_id": "account-welcome"
}
}render_templateRenderizar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
version_id | string | no | ID de versión opcional; por defecto, el borrador y, si no hay, la versión publicada. |
data | object | no | Valores de las variables; por defecto, los datos de ejemplo de la versión. |
{
"name": "render_template",
"arguments": {
"template_id": "account-welcome",
"data": {
"first_name": "Asha"
}
}
}send_template_testEnviar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
to | string[] | sí | Destinatarios de la prueba. (1–100 elementos) |
from | string | no | Remitente en un dominio verificado; por defecto, el From de la plantilla. |
version_id | string | no | ID de versión opcional. |
data | object | no | Valores de las variables; por defecto, los datos de ejemplo. |
{
"name": "send_template_test",
"arguments": {
"template_id": "account-welcome",
"to": [
"owner@example.com"
]
}
}publish_templatePublicar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
{
"name": "publish_template",
"arguments": {
"template_id": "account-welcome"
}
}archive_templateArchivar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
{
"name": "archive_template",
"arguments": {
"template_id": "account-welcome"
}
}restore_templateRestaurar una plantilla archivada
Vuelve a activar una plantilla archivada.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | ID o clave de la plantilla. (máx. 128 caracteres) |
{
"name": "restore_template",
"arguments": {
"template_id": "account-welcome"
}
}Dominios y DNS
list_domainsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_domains",
"arguments": {}
}get_domainObtener 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "get_domain",
"arguments": {
"domain_id": "dom_123"
}
}add_domainAgregar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | Nombre de dominio sin más, p. ej. example.com o mail.example.com. (máx. 253 caracteres) |
default_from | string | no | Dirección de remitente predeterminada opcional en este dominio. |
{
"name": "add_domain",
"arguments": {
"name": "example.com"
}
}verify_domainVerificar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "verify_domain",
"arguments": {
"domain_id": "dom_123"
}
}delete_domainEliminar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "delete_domain",
"arguments": {
"domain_id": "dom_123"
}
}get_dns_providerDetectar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "get_dns_provider",
"arguments": {
"domain_id": "dom_123"
}
}get_domain_connect_linkObtener un enlace de configuración DNS con un clic
Cuando get_dns_provider informa providers.domainConnect.available, crea una URL de consentimiento firmada. Entréguesela a la persona: ella la abre y aprueba el cambio de DNS en su proveedor. No cambia nada hasta que lo apruebe. 409 si no es compatible.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "get_domain_connect_link",
"arguments": {
"domain_id": "dom_123"
}
}Correo entrante
setup_inboundHabilitar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "setup_inbound",
"arguments": {
"domain_id": "dom_123"
}
}verify_inboundVerificar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
{
"name": "verify_inbound",
"arguments": {
"domain_id": "dom_123"
}
}list_inboxesListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | no | Filtro opcional por ID de dominio. |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_inboxes",
"arguments": {
"domain_id": "dom_123"
}
}get_inboxObtener una bandeja de entrada
Recupera una dirección de entrada.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
inbox_id | string | sí | 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) |
{
"name": "get_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}create_inboxCrear 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain_id | string | sí | ID del dominio (empieza por dom_), tal como lo devuelve una herramienta de listado o de creación. (máx. 128 caracteres) |
local_part | string | sí | Parte anterior a la @, p. ej. support. (máx. 64 caracteres) |
name | string | no | Nombre visible opcional. |
{
"name": "create_inbox",
"arguments": {
"domain_id": "dom_123",
"local_part": "support",
"name": "Support"
}
}update_inboxRenombrar, habilitar o deshabilitar una bandeja de entrada
Cambia el nombre de una bandeja de entrada o establece su estado en active / disabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
inbox_id | string | sí | 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) |
name | string | no | Nombre visible nuevo. |
status | string | no | Estado nuevo. (uno de active, disabled) |
{
"name": "update_inbox",
"arguments": {
"inbox_id": "inb_123",
"status": "disabled"
}
}set_inbox_forwardingReenviar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
inbox_id | string | sí | 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_to | string,null | sí | Dirección de correo de destino del reenvío, o null para desactivarlo. (máx. 254 caracteres) |
{
"name": "set_inbox_forwarding",
"arguments": {
"inbox_id": "inb_123",
"forward_to": "team@example.net"
}
}delete_inboxEliminar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
inbox_id | string | sí | 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) |
{
"name": "delete_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}Entregabilidad, rebotes y supresiones
deliverability_statsObtener 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.
{
"name": "deliverability_stats",
"arguments": {}
}deliverability_accountGet account delivery rates
Daily ladder, today's usage, 7-day hard-bounce and complaint rates against the promote, hold, and pause thresholds, and a per-day trend. Diagnostic text is plain text.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
days | integer | no | (one of 7, 30, 90) |
{
"name": "deliverability_account",
"arguments": {
"days": 30
}
}deliverability_domainsGet domain delivery rates
Per sending domain: sent, delivered, hard and soft bounces, complaints, failures, rates, and an active Gmail cap or 4.7.28 backoff when one applies.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
days | integer | no | |
domain | string | no | |
limit | integer | no | |
offset | integer | no |
{
"name": "deliverability_domains",
"arguments": {
"days": 30
}
}deliverability_sendersGet sender delivery rates
Per From address: sent, delivered, hard and soft bounces, complaints, failures, and rates.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
days | integer | no | |
domain | string | no | |
limit | integer | no | |
offset | integer | no |
{
"name": "deliverability_senders",
"arguments": {
"days": 30
}
}score_emailScore an email's content
A checklist of one email's content before it is sent: 100 for a plain email with no links and no images, lower for each thing mail filters look at (a designed layout, links to another site than the sender's, link shorteners, images with few words, hidden text, capitals, an empty subject, very long HTML). Returns each finding with the points it costs and a one-line suggestion, most points first. Read-only: nothing is stored or sent. Pass the email as written; the unsubscribe footer and tracking SendHQ adds are not scored. It looks at content only: sender reputation, authentication and how recipients react decide more of where mail lands, so treat it as a checklist, not a prediction.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
subject | string | no | The subject line. |
html | string | no | The HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars) |
text | string | no | The plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars) |
from | string | no | The sender: an email address or a domain such as example.com. Without it, links to other sites are not judged. (max 320 chars) |
{
"name": "score_email",
"arguments": {
"from": "hello@example.com",
"subject": "Your cart is still here",
"html": "<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>"
}
}list_sender_reputationListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_sender_reputation",
"arguments": {}
}list_suppressionsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_suppressions",
"arguments": {}
}remove_suppressionQuitar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email | string | sí | Dirección del destinatario suprimido. (máx. 320 caracteres) |
{
"name": "remove_suppression",
"arguments": {
"email": "fixed-mailbox@example.net"
}
}list_blocked_recipientsListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_blocked_recipients",
"arguments": {}
}Campaigns
list_contactsList contacts
Campaigns: Newest-first contacts with their status, consent evidence, tags, custom fields, engagement (bot-filtered, estimated opens and clicks), and the lists they are subscribed to. Filter by list, status (including dormant), email/name substring (* is an email wildcard, e.g. *@example.com), tag, source, signup date, or a saved segment. Paginated: the result includes pagination {offset, limit, returned, has_more, next_offset}.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | no | Only members of this list (lst_…). |
status | string | no | Only contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant) |
query | string | no | Email or name contains this text; * is a wildcard on the email. (max 200 chars) |
tag | string | no | Only contacts with this tag. (max 60 chars) |
source | string | no | How the contact was added. (one of form, api, import) |
after | string | no | Signed up at or after this time. ISO 8601 date or date-time. (max 40 chars) |
before | string | no | Signed up before this time. ISO 8601 date or date-time. (max 40 chars) |
segment_id | string | no | Only contacts matching this saved segment (seg_…). |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_contacts",
"arguments": {
"status": "subscribed"
}
}create_contactAdd a contact
Campaigns: Add one contact to the workspace, optionally to lists and with tags. A subscribed contact (the default) needs consent_basis: how this person agreed to receive your email. Only add people who asked for your email. Use status: unsubscribed to record an opt-out. Addresses already suppressed or unsubscribed from the workspace are stored with that status. Fails with 409 if the email already exists.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email | string | sí | Email address. (max 320 chars) |
name | string | no | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | no | Custom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field. |
tags | string[] | no | Tags to attach, e.g. ["VIP"]. Up to 50. (0–50 items) |
list_ids | string[] | no | Lists to add the contact to (lst_…). (0–100 items) |
status | string | no | subscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed) |
consent_basis | string | no | How these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars) |
{
"name": "create_contact",
"arguments": {
"email": "ada@example.net",
"name": "Ada Lovelace",
"consent_basis": "Ticked the newsletter box at checkout on acme.com"
}
}upsert_contactCreate or update a contact by email
Campaigns: Create the contact with this email, or change the one that exists: set name, timezone, and locale, merge fields, and add tags. A new contact needs consent_basis and takes the status its address already has (bounced or complained when suppressed, unsubscribed when it opted out, otherwise subscribed). An existing contact's status is never changed, so nobody is resubscribed. Unlike create_contact it does not fail when the email exists. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email | string | sí | Email address. (max 320 chars) |
name | string | no | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | no | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
tags | string[] | no | Tags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items) |
timezone | string | no | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
locale | string | no | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
consent_basis | string | no | How this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars) |
{
"name": "upsert_contact",
"arguments": {
"email": "ada@example.net",
"name": "Ada Lovelace",
"fields": {
"plan": "pro"
},
"timezone": "Europe/London",
"consent_basis": "Created an account on acme.com and accepted product emails"
}
}get_contactGet a contact
Campaigns: One contact by ID or email: status, consent evidence (source, basis, opt-in and confirmation times), custom fields, and subscribed lists.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
contact_id | string | sí | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "get_contact",
"arguments": {
"contact_id": "ct_123"
}
}update_contactUpdate, tag, or unsubscribe a contact
Campaigns: Change a contact's name, merge custom fields (null removes one), change tags (tags replaces the whole set; add_tags and remove_tags change it), or set status to unsubscribed. A contact can never be resubscribed through the API; only the recipient can, by confirming a signup form.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
contact_id | string | sí | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
name | string | no | New display name. (max 200 chars) |
fields | object | no | Custom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field. |
tags | string[] | no | Replace all of the contact's tags with these. (0–50 items) |
add_tags | string[] | no | Tags to add. (0–50 items) |
remove_tags | string[] | no | Tags to remove. (0–50 items) |
status | string | no | Only unsubscribed is accepted. (one of unsubscribed) |
{
"name": "update_contact",
"arguments": {
"contact_id": "ct_123",
"fields": {
"plan": "team"
}
}
}delete_contactDelete a contact
DESTRUCTIVE: permanently delete a contact and its list memberships. Suppressions and recorded unsubscribes are kept, so the address still cannot be mailed if it is added again. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
contact_id | string | sí | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "delete_contact",
"arguments": {
"contact_id": "ct_123"
}
}import_contactsImport contacts from CSV
Campaigns: Import up to 5,000 CSV rows (5 MB) per call, optionally into a list. The header row needs an email column; name (or first_name/last_name), status, and tags (separated by ; or |) are recognized and other columns become custom fields. consent_basis is required and recorded on every new contact. tags are added to every accepted row. Rows whose status says unsubscribed import as unsubscribed; existing contacts keep their status. Returns counts of accepted, created, existing, skipped (duplicates), and invalid rows with line numbers.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
csv | string | sí | The CSV file content, header row first. (max 5242880 chars) |
list_id | string | no | Add every accepted row to this list (lst_…). |
consent_basis | string | sí | How these people agreed to receive your email, recorded as consent evidence, e.g. Signed up on acme.com/newsletter (double opt-in), exported from Mailchimp. 10-500 characters. (max 500 chars) |
tags | string[] | no | Tags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items) |
update_existing | boolean | no | Merge names and fields into contacts that already exist. Their status never changes. |
{
"name": "import_contacts",
"arguments": {
"csv": "email,name\nada@example.net,Ada Lovelace\n",
"consent_basis": "Newsletter signups exported from Mailchimp (double opt-in)"
}
}list_contact_importsList contact imports
Campaigns: Recent CSV imports with their consent basis and row counts.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_contact_imports",
"arguments": {}
}bulk_update_contactsBulk update contacts
DESTRUCTIVE when action is delete (permanent) or unsubscribe (cannot be undone through the API). Apply one action to up to 10,000 contacts: the IDs in contact_ids, or everyone matching filter (the list_contacts filters). Actions: tag / untag (with tags), add_to_list / remove_from_list (with list_id), unsubscribe, delete. Adding to a list mirrors each contact's status, so nobody is resubscribed. delete needs confirm_count equal to the number of contacts it would delete: call once without it to get that count (409), confirm with the user, then repeat with it. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
action | string | sí | What to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete) |
contact_ids | string[] | no | Contact IDs (ct_…). Use this or filter. (0–10000 items) |
filter | object | no | Everyone matching these list_contacts filters. Use this or contact_ids. |
filter.list_id | string | no | Members of this list. |
filter.status | string | no | Only contacts with this status. dormant: stopped opening and did not answer list cleanup, so broadcasts skip them. (one of subscribed, pending, unsubscribed, bounced, complained, dormant) |
filter.query | string | no | Email or name contains; * is an email wildcard. (max 200 chars) |
filter.tag | string | no | Has this tag. (max 60 chars) |
filter.source | string | no | How the contact was added. (one of form, api, import) |
filter.after | string | no | Signed up at or after. ISO 8601 date or date-time. (max 40 chars) |
filter.before | string | no | Signed up before. ISO 8601 date or date-time. (max 40 chars) |
filter.segment_id | string | no | Matches this segment. |
tags | string[] | no | For tag and untag. (0–50 items) |
list_id | string | no | For add_to_list and remove_from_list (lst_…). |
confirm_count | integer | no | For delete: the number of contacts that will be deleted, from the 409 response. (0–…) |
{
"name": "bulk_update_contacts",
"arguments": {
"action": "tag",
"tags": [
"october"
],
"filter": {
"list_id": "lst_123",
"status": "subscribed"
}
}
}list_tagsList contact tags
Campaigns: The workspace's contact tags, most used first, with how many contacts carry each (up to 500). Paginated.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_tags",
"arguments": {}
}list_contact_fieldsList custom contact fields
Campaigns: Defined custom contact fields with label and type (text, number, date). Defined fields are known to check_broadcast's merge-tag check and typed in segment conditions. Contacts may also carry undefined keys. Paginated.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_contact_fields",
"arguments": {}
}set_contact_fieldDefine a custom contact field
Campaigns: Create or change a custom field definition (label and type). Values live on each contact's fields. Built-in merge tags (email, name, first_name, last_name, fields, unsubscribe_url) cannot be used as keys. A workspace may define 50 fields.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
field_key | string | sí | Field key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars) |
label | string | no | Label shown in the dashboard. Defaults to the key. (max 80 chars) |
type | string | no | text (default), number, or date. (one of text, number, date) |
{
"name": "set_contact_field",
"arguments": {
"field_key": "plan",
"label": "Plan",
"type": "text"
}
}delete_contact_fieldDelete a custom field definition
DESTRUCTIVE: delete a custom field definition. Values already stored on contacts are kept. Fails with 404 when the field is not defined. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
field_key | string | sí | Field key: a lowercase letter, then up to 39 of a-z, 0-9, and _ (e.g. plan). Used in content as {{fields.plan}}. (max 40 chars) |
{
"name": "delete_contact_field",
"arguments": {
"field_key": "plan"
}
}list_segmentsList segments
Campaigns: Saved segments with count (subscribed, non-dormant contacts in the workspace that match now) and fields, the condition fields and operators each accepts. Paginated.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_segments",
"arguments": {}
}get_segmentGet a segment
Campaigns: One segment with its conditions and live count.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
segment_id | string | sí | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
{
"name": "get_segment",
"arguments": {
"segment_id": "seg_123"
}
}preview_segmentPreview segment conditions
Campaigns: Count and sample (up to 5) the subscribed, non-dormant contacts that match conditions without saving them. Read-only; use it to check conditions before create_segment.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
match | string | no | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | no | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sí | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | no | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sí | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | no | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "preview_segment",
"arguments": {
"match": "all",
"conditions": [
{
"field": "tag",
"op": "has",
"value": "VIP"
},
{
"field": "opened",
"op": "in_last_days",
"value": 90
}
]
}
}create_segmentCreate a segment
Campaigns: Save a segment: up to 20 conditions joined by match. Use it as a broadcast's audience.segment_id, as list_contacts segment_id, or in bulk_update_contacts filters. A workspace may have 200 segments.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | Segment name. (max 120 chars) |
match | string | no | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | no | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sí | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | no | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sí | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | no | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "create_segment",
"arguments": {
"name": "Engaged pro customers",
"conditions": [
{
"field": "fields.plan",
"op": "equals",
"value": "pro"
},
{
"field": "opened",
"op": "in_last_days",
"value": 90
}
]
}
}update_segmentUpdate a segment
Campaigns: Rename a segment or change match or conditions (which replaces the whole list). Broadcasts using it pick up the change when they start sending.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
segment_id | string | sí | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
name | string | no | Segment name. (max 120 chars) |
match | string | no | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | no | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | sí | tag, list, status, source, email, name, signed_up, opened, clicked, opens, sends_without_open, country, or a custom field as fields.<key> (or field together with key). (max 48 chars) |
conditions[].key | string | no | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | sí | tag: has, not_has. list: in, not_in (a list ID). status: is, is_not (subscribed, pending, unsubscribed, bounced, complained, dormant). source: is, is_not (form, api, import). email: contains, not_contains, ends_with. name: is_set, not_set. signed_up: before, after (YYYY-MM-DD), in_last_days, not_in_last_days. opened / clicked: in_last_days, not_in_last_days, ever, never. opens / sends_without_open: gte, lte. country: is, is_not (two-letter code). Custom fields: equals, not_equals, contains, gt, lt, before, after, is_set, not_set. (one of has, not_has, in, not_in, is, is_not, contains, not_contains, ends_with, is_set, not_set, before, after, in_last_days, not_in_last_days, ever, never, gte, lte, equals, not_equals, gt, lt) |
conditions[].value | string,number | no | Required except for is_set, not_set, ever, and never. A number of days for in_last_days / not_in_last_days, a number for gte, lte, gt, lt, a date (YYYY-MM-DD) for before / after. |
{
"name": "update_segment",
"arguments": {
"segment_id": "seg_123",
"name": "Pro customers"
}
}delete_segmentDelete a segment
DESTRUCTIVE: delete a saved segment. Contacts are not affected. Fails with 409 while a sending or scheduled broadcast uses it. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
segment_id | string | sí | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
{
"name": "delete_segment",
"arguments": {
"segment_id": "seg_123"
}
}list_listsList contact lists
Campaigns: Contact lists with subscribed, pending, and unsubscribed counts and their hosted signup form settings.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_lists",
"arguments": {}
}create_listCreate a list
Campaigns: Create a contact list. Set form_enabled to publish a hosted double opt-in signup form (its URL is in form.url); form_from is the sender, on a verified domain, of the confirmation email, and redirect_url is an optional https page shown after confirming. welcome sends one welcome email when someone confirms. site publishes a public newsletter site at https://sendhq.cc/n/<slug> with the signup form, sent issues, and RSS.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | List name, shown on the signup form. (max 200 chars) |
description | string | no | Short description shown on the signup form. (max 500 chars) |
form_enabled | boolean | no | Publish the hosted signup form. |
form_from | string | no | Sender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars) |
redirect_url | string | no | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | no | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | no | Send it. |
welcome.subject | string | no | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | no | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | no | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | no | Public newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409. |
site.enabled | boolean | no | Publish the site. |
site.slug | string,null | no | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | no | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | no | Short description under the title. (max 300 chars) |
site.accent | string,null | no | Accent color, e.g. #0a7d4f. |
{
"name": "create_list",
"arguments": {
"name": "Product updates"
}
}get_listGet a list
Campaigns: One list with member counts and signup form settings.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | sí | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_list",
"arguments": {
"list_id": "lst_123"
}
}update_listUpdate a list
Campaigns: Rename a list, change its description, or change its hosted signup form, welcome email, or newsletter site. Omitted keys inside welcome and site keep their value.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | sí | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
name | string | no | New name. (max 200 chars) |
description | string | no | New description. (max 500 chars) |
form_enabled | boolean | no | Publish or unpublish the hosted signup form. |
form_from | string | no | Sender of signup confirmation emails, on a verified domain. (max 320 chars) |
redirect_url | string | no | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | no | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | no | Send it. |
welcome.subject | string | no | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | no | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | no | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | no | Public newsletter site at https://sendhq.cc/n/<slug>: a signup form, every issue sent with web.enabled, and an RSS feed at /n/<slug>/feed.xml. Needs the signup form on. A reserved or taken slug fails with 409. |
site.enabled | boolean | no | Publish the site. |
site.slug | string,null | no | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | no | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | no | Short description under the title. (max 300 chars) |
site.accent | string,null | no | Accent color, e.g. #0a7d4f. |
{
"name": "update_list",
"arguments": {
"list_id": "lst_123",
"form_enabled": false
}
}delete_listDelete a list
DESTRUCTIVE: delete a list and its memberships. The contacts themselves are kept. Fails with 409 while a broadcast to the list is sending. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | sí | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
{
"name": "delete_list",
"arguments": {
"list_id": "lst_123"
}
}add_list_contactsAdd contacts to a list
Campaigns: Add up to 500 existing contacts to a list by ID or email. Subscribed contacts join subscribed; others join in their current state. Unknown references come back in notFound.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | sí | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_ids | string[] | no | Contact IDs (ct_…). (0–500 items) |
emails | string[] | no | Contact email addresses. (0–500 items) |
{
"name": "add_list_contacts",
"arguments": {
"list_id": "lst_123",
"emails": [
"ada@example.net"
]
}
}remove_list_contactRemove a contact from a list
DESTRUCTIVE: remove one contact from a list. The contact and its status are kept. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
list_id | string | sí | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_id | string | sí | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "remove_list_contact",
"arguments": {
"list_id": "lst_123",
"contact_id": "ct_123"
}
}list_broadcastsList broadcasts
Campaigns: Newest-first broadcasts with their status. Paginated: the result includes pagination.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
status | string | no | Only broadcasts with this status. (one of draft, sending, sent, cancelled, failed) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_broadcasts",
"arguments": {}
}create_broadcastCreate a broadcast draft
Campaigns: Create a draft broadcast to one list. Content is html and/or text, markdown, a block document in content, or a published hosted template. Raw content supports merge tags: {{first_name}}, {{name}}, {{email}}, {{fields.plan}}, with fallbacks like {{first_name | there}}. audience narrows it to a segment and/or a number of people (most engaged first with order: engaged); tracking turns open and click tracking off; web publishes it on the list's newsletter site once sent. Nothing is sent until send_broadcast or schedule_broadcast; run check_broadcast and send_broadcast_test first.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | no | Internal name. Defaults to the subject. (max 200 chars) |
list_id | string | no | The list to send to (lst_…). |
from | string | no | Sender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars) |
reply_to | string | no | Reply-To address. (max 320 chars) |
subject | string | no | Subject line; merge tags allowed. (max 998 chars) |
preview_text | string | no | Inbox preview text shown after the subject. (max 300 chars) |
html | string | no | HTML body; merge tags allowed and escaped. |
text | string | no | Plain-text body; merge tags allowed. |
template | object | no | A published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields. |
template.id | string | no | |
template.key | string | no | |
template.version_id | string | no | |
markdown | string | no | Markdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars) |
content | object,null | no | Block document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent. |
editor | string | no | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | no | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | no | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | no | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | no | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | no | Open and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email. |
tracking.opens | boolean | no | Add an open pixel. |
tracking.clicks | boolean | no | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | no | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | no | Publish it. |
web.slug | string,null | no | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | no | Keep it at the top of the site. |
{
"name": "create_broadcast",
"arguments": {
"list_id": "lst_123",
"from": "news@example.com",
"subject": "October update",
"markdown": "Hi {{first_name | there}}, here's what shipped.",
"audience": {
"order": "engaged",
"limit": 1000
}
}
}get_broadcastGet a broadcast
Campaigns: One broadcast with its content and, once sending, recipient totals (queued, sending, sent, held, skipped, failed). While a limit or reputation pause holds delivery, lastError explains why and nextAttemptAt says when it resumes.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}update_broadcastEdit a draft broadcast
Campaigns: Change any field of an unscheduled draft broadcast (content, audience, tracking, web). A scheduled draft must be unscheduled first (unschedule_broadcast); sent or sending broadcasts cannot be edited.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
name | string | no | Internal name. (max 200 chars) |
list_id | string | no | The list to send to. |
from | string | no | Sender on a verified domain. (max 320 chars) |
reply_to | string | no | Reply-To address. (max 320 chars) |
subject | string | no | Línea de asunto. (máx. 998 caracteres) |
preview_text | string | no | Inbox preview text. (max 300 chars) |
html | string | no | Cuerpo HTML. |
text | string | no | Cuerpo en texto sin formato. |
template | object,null | no | A published hosted template, or null to remove it. |
markdown | string | no | Markdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars) |
content | object,null | no | Block document ({"type": "doc", "content": [...]}, the dashboard editor's format: paragraph, heading, bulletList, orderedList, blockquote, image, button, callout, horizontalRule, codeBlock). Rendered with the workspace design unless html is also sent. |
editor | string | no | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | no | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | no | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | no | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | no | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | no | Open and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email. |
tracking.opens | boolean | no | Add an open pixel. |
tracking.clicks | boolean | no | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | no | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | no | Publish it. |
web.slug | string,null | no | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | no | Keep it at the top of the site. |
{
"name": "update_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"subject": "October product update"
}
}delete_broadcastDelete a draft broadcast
DESTRUCTIVE: permanently delete a draft broadcast. Broadcasts that were sent cannot be deleted. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "delete_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcastSend a broadcast
SENDS REAL EMAIL to the broadcast's audience: every subscribed, non-dormant member of its list, narrowed by its segment and limit. Only call it when the user asked to send this broadcast now. Each message goes through the normal checks (verified domain, marketing plan, suppressions, unsubscribes, reputation, daily and monthly limits) and carries one-click unsubscribe from this list; members that cannot be mailed are skipped. Each contact is sent at most once. Delivery continues in the background: poll get_broadcast for totals and get_broadcast_report for engagement. A scheduled broadcast fails with 409 until unscheduled. Unpaid workspaces (integration trial) can send only to the account email. Pass idempotency_key so a retry cannot start the send twice. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
idempotency_key | string | no | Encabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres) |
{
"name": "send_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"idempotency_key": "october-update"
}
}cancel_broadcastCancel a broadcast
DESTRUCTIVE: stop a draft or sending broadcast for good. Recipients not yet sent are marked skipped; messages already handed to the provider are not recalled. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "cancel_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}list_broadcast_recipientsList broadcast recipients
Campaigns: Per-recipient outcomes and engagement of a broadcast: queued, sending, sent, held, skipped (with the reason), or failed (with the error), the inbox provider, delivered/opened/clicked/bounced/complained/unsubscribed times, and the email ID to inspect delivery events with list_email_events. Filter by outcome, by activity (who opened, clicked, did not open, ...), or by email. Opens are bot-filtered estimates, never proof of reading. Paginated.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
status | string | no | Only recipients with this outcome. (one of queued, sending, sent, held, skipped, failed) |
activity | string | no | Only recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed) |
query | string | no | Recipient email contains this text. (max 200 chars) |
include | string | no | links adds the links each recipient clicked (implied by activity: clicked). (one of links) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_broadcast_recipients",
"arguments": {
"broadcast_id": "bc_123",
"status": "failed"
}
}check_broadcastRun a broadcast's pre-send checks
Campaigns: The review list shown before sending: sender verification, subject, preview text, content, audience size, size against Gmail's 102 KB clipping limit, postal address, merge tags without data or fallback, empty or shortened links, image descriptions, placeholder text, spam-prone wording, the trial's own-address rule, and whether a test was sent. ready is false while any check has level block; schedule_broadcast refuses then. Fix warn items or tell the user about them.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "check_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcast_testSend a broadcast test
SENDS REAL EMAIL: a copy of the draft marked [Test] to up to 5 addresses (default: the saved test recipients, or the account email), with merge tags filled from contact_id or a sample contact. Never goes to the list. Only send to addresses the user gave or owns. Limited to 100 test sends a day. Template broadcasts are tested with send_template_test. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
to | string[] | no | Test recipients (up to 5). (1–5 items) |
contact_id | string | no | Fill merge tags from this contact (ct_…). (max 320 chars) |
remember | boolean | no | Save to as the default test recipients. |
{
"name": "send_broadcast_test",
"arguments": {
"broadcast_id": "bc_123",
"to": [
"owner@example.com"
]
}
}schedule_broadcastSchedule a broadcast
SENDS REAL EMAIL at scheduled_at to the broadcast's audience, with the same checks as send_broadcast. Only call it when the user asked to send this broadcast at that time. The pre-send checks run now (422 with checks if one blocks). It starts within about a minute of the time; if it can no longer send then, it returns to a draft with the reason in lastError. A scheduled draft cannot be edited until unschedule_broadcast. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
scheduled_at | string | sí | When to send: ISO 8601 date-time with a timezone, at least a minute and at most a year ahead, e.g. 2026-11-10T09:00:00Z. (max 40 chars) |
{
"name": "schedule_broadcast",
"arguments": {
"broadcast_id": "bc_123",
"scheduled_at": "2026-11-10T09:00:00Z"
}
}unschedule_broadcastUnschedule a broadcast
Campaigns: Return a scheduled broadcast to an editable draft so it does not send. Fails with 409 when it is not scheduled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "unschedule_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}duplicate_broadcastDuplicate a broadcast
Campaigns: Copy any broadcast (draft, sent, or cancelled) into a new draft named <name> (copy) with the same list, sender, content, audience, and tracking settings. Nothing is sent.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "duplicate_broadcast",
"arguments": {
"broadcast_id": "bc_123"
}
}send_broadcast_to_moreSend a broadcast to more people
SENDS REAL EMAIL: sends a sent or sending broadcast to up to limit more people in its audience who have not received it (the rest of a limited audience, or people who joined since), in its audience order. Only call it when the user asked for this. Same checks as send_broadcast; each contact still gets it at most once. Fails with 422 when everyone already got it. Pass idempotency_key so a retry cannot add people twice. Part of Campaigns.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
limit | integer | sí | How many more people at most. (1–10000000) |
idempotency_key | string | no | Encabezado Idempotency-Key (máx. 200 caracteres). Reutilícelo solo para reintentar exactamente esta solicitud. (máx. 200 caracteres) |
{
"name": "send_broadcast_to_more",
"arguments": {
"broadcast_id": "bc_123",
"limit": 500,
"idempotency_key": "october-update-more-1"
}
}get_broadcast_reportGet a broadcast report
Campaigns: Engagement for a sending or sent broadcast: unique and total opens and clicks, bounces, complaints, and unsubscribes with rates in percent, the same per inbox provider, clicks per link, first opens and clicks by hour, and the average of the previous five broadcasts. Opens are estimates: automated requests (scanners, link previews, privacy prefetching) are counted only in machine. Never claim that a person read the email. Fails with 409 for a draft.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
broadcast_id | string | sí | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
{
"name": "get_broadcast_report",
"arguments": {
"broadcast_id": "bc_123"
}
}get_newsletter_settingsGet newsletter settings
Campaigns: The postal address added to every marketing email footer, the design (accent color, font, alignment) used for Markdown and block content, list cleanup settings, and default test recipients.
Sin parámetros.
{
"name": "get_newsletter_settings",
"arguments": {}
}update_newsletter_settingsUpdate newsletter settings
Campaigns: Change the postal address (required in marketing email by CAN-SPAM and CASL), design, list cleanup, or default test recipients. Omitted keys keep their value. List cleanup is on by default and sends email automatically: a subscriber who got afterSends broadcasts in a row without opening or clicking and has been quiet for quietDays gets one "still want these?" email; a week later those who did not confirm become dormant (kept, but skipped by broadcasts). Confirm with the user before turning it on or changing its email.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
postal_address | string | no | Sender's postal address for the footer. Empty string removes it. (max 300 chars) |
design | object | no | Rendering design for Markdown and block content. |
design.accentColor | string,null | no | Hex color like #0a7d4f, or null for the default. |
design.font | string | no | Font family. (one of sans, serif, mono) |
design.align | string | no | Text alignment. (one of left, center) |
cleanup | object | no | List cleanup of readers who stopped opening. |
cleanup.enabled | boolean | no | Turn list cleanup on or off. |
cleanup.afterSends | integer | no | Broadcasts in a row without an open or click (3-50). (3–50) |
cleanup.quietDays | integer | no | Days without engagement (30-730). (30–730) |
cleanup.subject | string,null | no | Subject of the cleanup email; merge tags allowed. (max 200 chars) |
cleanup.body | string,null | no | Body text of the cleanup email. (max 2000 chars) |
cleanup.from | string,null | no | Sender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars) |
test_recipients | string[] | no | Default addresses for send_broadcast_test (up to 5). (0–5 items) |
{
"name": "update_newsletter_settings",
"arguments": {
"postal_address": "Acme Inc., 1 Main St, Springfield",
"design": {
"accentColor": "#0a7d4f"
}
}
}get_campaign_overviewGet campaign overview
Campaigns: Subscriber growth and recent results for the last days (7-365, default 30): active, dormant, and pending subscribers, joined and left, a daily series, and the six latest broadcasts with open and click rates (bot-filtered estimates) and their average.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
days | integer | no | Window in days, 7 to 365. Defaults to 30. (7–365) |
{
"name": "get_campaign_overview",
"arguments": {
"days": 30
}
}list_uploaded_imagesList uploaded images
Campaigns: The workspace's 60 most recent editor image uploads with their public URLs (https://sendhq.cc/i/<id>), to reuse in broadcast HTML, Markdown, or image blocks. Uploading needs the dashboard or the REST API (raw image body). Paginated.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_uploaded_images",
"arguments": {}
}Automations, events, and sending limits
track_eventRecord something a contact did
SENDS REAL EMAIL later, when an automation is listening: the contact enters every automation that is on and starts on this event, and that automation then emails them on its schedule, within the workspace's sending limits and hours. Only record what the person really did. In order: the contact changes in contact and the event are saved; open enrolments whose automation names the event as its goal end as converted, and ones that list it as a stop event end; then the contact enters the automations that start on it, unless already in them or reentry forbids it. A contact that is unsubscribed, bounced, or complained is recorded and can leave automations but never enters one. A new contact needs contact.consent_basis. Pass dedupe_key so a retry changes nothing and returns the first result. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
email | string | sí | The contact's email address. (max 320 chars) |
event | string | sí | What they did: a lowercase letter, then a-z, 0-9, and _ (e.g. checkout_started). Names starting email. are reserved. (max 64 chars) |
properties | object | no | Up to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved. |
occurred_at | string | no | When it happened, ISO 8601 with a time zone. Defaults to now; may not be in the future. The automation's emails are timed from it. (max 40 chars) |
dedupe_key | string | no | Stable ID for this event (max 200 chars). A second call with the same key records nothing and returns the first result. (max 200 chars) |
contact | object | no | Changes to the contact, applied with the event. |
contact.name | string | no | Display name. (max 200 chars) |
contact.fields | object | no | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
contact.timezone | string | no | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
contact.locale | string | no | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
contact.consent_basis | string | no | How this person agreed to receive your email, e.g. Created an account on acme.com and accepted product emails. Required when the email is not a contact yet. 10-500 characters. (max 500 chars) |
{
"name": "track_event",
"arguments": {
"email": "ada@example.net",
"event": "checkout_started",
"properties": {
"plan": "pro"
},
"dedupe_key": "checkout_8f3a"
}
}list_automationsList automations
Automations: Every automation in priority order with its status (draft, on, or off), how many emails it has, and totals for the last 30 days (entered, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held). held counts each time an email was made to wait by the sending limits, the sending hours, or the automation's daily cap. Each automation carries domain, the domain of its from_address (null while it has no sender). domain narrows the list to the automations that send from one domain (none: those with no sender yet); domains always lists every sender domain of the workspace, in alphabetical order, with how many automations each has. Email bodies are not included; use get_automation. For other date ranges and daily numbers use get_automation_report. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
domain | string | no | Only the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_automations",
"arguments": {
"domain": "example.com"
}
}get_automationGet an automation
Automations: One automation with its emails in order and their language versions, how many people are in it now, and overlap: the other automations that are on and currently have the same people in them, with goes_first true for one that ranks above this automation (the shared people get its emails first and wait in this one). to_fill lists what must still be filled in before it can be turned on: placeholders of the template library left in its emails, and workspace names they print that are blank. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
{
"name": "get_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}create_automationCreate an automation
Automations: Create a timed sequence of emails for one kind of person, as a draft. To start from a ready-made email instead (welcome, onboarding, trial, abandoned checkout, failed payment, winback and more), use use_automation_template. Nothing is sent until set_automation_status turns it on. key is its address and cannot be changed. entry says how people enter, exit_rules when they leave, and steps are the emails, each due offset_seconds after the person entered. from_address must be on a verified domain. Fails with 409 when the key is taken. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
key | string | sí | Address of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars) |
name | string | sí | Name shown in the dashboard. (max 200 chars) |
audience_label | string | no | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | no | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | no | How people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end. |
entry.type | string | sí | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | no | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | no | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | no | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | no | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | no | When people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules. |
exit_rules.goal_event | string,null | no | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | no | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | no | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | no | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | no | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | no | Skip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations. |
settings.daily_send_cap | integer,null | no | At most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…) |
settings.daily_entry_cap | integer,null | no | Stored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…) |
settings.holdout_pct | number | no | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | no | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | no | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | no | Priority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000) |
from_name | string | no | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | no | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | no | Reply-To address. (max 320 chars) |
steps | object[] | no | The emails, in order. position defaults to the place in this list. (0–50 items) |
steps[].position | integer | no | Position of the email in the automation, 1 to 50. (1–50) |
steps[].subject | string | no | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
steps[].preheader | string | no | Inbox preview line. (max 300 chars) |
steps[].content | object | no | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
steps[].html | string | no | HTML body. The unsubscribe footer is added automatically. |
steps[].text | string | no | Cuerpo en texto sin formato. |
steps[].editor | string | no | How the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design) |
steps[].offset_seconds | integer | no | When the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400) |
steps[].skip_if_empty | string[] | no | Merge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items) |
steps[].ignore_send_window | boolean | no | Send as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply. |
{
"name": "create_automation",
"arguments": {
"key": "checkout-recovery",
"name": "Checkout recovery",
"audience_label": "Started checkout and left",
"goal_label": "paid",
"from_name": "Acme",
"from_address": "hello@example.com",
"entry": {
"type": "event",
"event": "checkout_started"
},
"exit_rules": {
"goal_event": "payment_completed"
},
"steps": [
{
"offset_seconds": 3600,
"subject": "Still thinking it over, {{ first_name | there }}?",
"html": "<p>Your cart is waiting.</p>"
}
]
}
}update_automationEdit an automation
Automations: Change an automation's name, labels, entry, exit rules, sender, or priority. settings are merged; entry and exit_rules replace the current ones. The key and the status cannot be changed here (use set_automation_status), and emails are changed with set_automation_step. If the automation is on, the change applies to people in it now, and an edit that would leave it unable to send is refused with 422 automation_not_ready. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
name | string | no | Name shown in the dashboard. (max 200 chars) |
audience_label | string | no | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | no | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | no | How people enter. {type: "event", event} starts on an event recorded with track_event; {type: "manual"} only through enroll_contact. bucket (with segment_id) and date_field (with field) are stored, but nobody enters through them automatically yet. reentry: never (default) or after_end. |
entry.type | string | sí | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | no | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | no | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | no | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | no | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | no | When people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules. |
exit_rules.goal_event | string,null | no | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | no | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | no | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | no | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | no | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | no | Skip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations. |
settings.daily_send_cap | integer,null | no | At most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…) |
settings.daily_entry_cap | integer,null | no | Stored for bucket entries, which are not started automatically yet. It does not limit people entering by event or through enroll_contact. null for no cap. (1–…) |
settings.holdout_pct | number | no | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | no | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | no | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | no | Priority. While one person is in several automations that are on, only the one with the lowest position emails them; the others wait and resume resume_after_days after it ends. (0–100000) |
from_name | string | no | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | no | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | no | Reply-To address. (max 320 chars) |
{
"name": "update_automation",
"arguments": {
"automation_key": "checkout-recovery",
"name": "Checkout recovery",
"settings": {
"holdout_pct": 10
}
}
}delete_automationDelete an automation
DESTRUCTIVE: permanently delete an automation with its emails, language versions, enrolments, send records, and statistics. Only a draft or switched-off automation that nobody is currently in can be deleted; otherwise it fails with 409. Confirm with the user first. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
{
"name": "delete_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}set_automation_stepCreate or change an email of an automation
Automations: Create the email at position, or change the fields you pass on the one that is there; fields left out keep their value. If the automation is on, people who have not received this email yet get the new version, so confirm the wording with the user. An existing email keeps its ID: people who already received it are not sent it again. With template, the email becomes that template of the library (see list_automation_templates): its subject, preview text and content replace the email's and its language versions are removed. While the automation is on, an email must keep a subject and content, and may not hold a placeholder of the template library such as [First step] or print a workspace name that is blank (422 automation_not_ready with problems). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sí | Position of the email in the automation, 1 to 50. (1–50) |
template | string | no | Id of a template of the library, e.g. welcome-note (not a set). The email becomes that template; other fields passed here are applied on top. The email's wait is not the template's: pass offset_seconds. (max 63 chars) |
subject | string | no | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | no | Inbox preview line. (max 300 chars) |
content | object | no | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
html | string | no | HTML body. The unsubscribe footer is added automatically. |
text | string | no | Cuerpo en texto sin formato. |
editor | string | no | How the email is made: blocks (the dashboard's writing editor, the default), html (your own HTML) or design (the dashboard's drag-and-drop builder). Only the builder makes a design; to send a designed email yourself, send html with editor html. (one of blocks, html, design) |
offset_seconds | integer | no | When the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400) |
skip_if_empty | string[] | no | Merge keys, e.g. ["fields.plan"]. The email is skipped for a contact where any of them is blank, 0, or false. (0–20 items) |
ignore_send_window | boolean | no | Send as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply. |
{
"name": "set_automation_step",
"arguments": {
"automation_key": "checkout-recovery",
"position": 2,
"offset_seconds": 86400,
"subject": "Your cart is still here",
"html": "<p>Pick up where you left off.</p>"
}
}delete_automation_stepRemove an email from an automation
DESTRUCTIVE: remove the email at position from an automation. It is no longer sent or listed; records of who already received it are kept. While the automation is on, its only email cannot be removed (409). Confirm with the user first. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sí | Position of the email in the automation, 1 to 50. (1–50) |
{
"name": "delete_automation_step",
"arguments": {
"automation_key": "checkout-recovery",
"position": 3
}
}set_automation_step_variantCreate or change a language version of an email
Automations: Save the version of one email for contacts whose locale is this language tag (e.g. fr); a contact with a regional locale such as pt-br gets the pt version when there is no pt-br one. Fields left out keep their value. A version without a body uses the email's own body, and a blank subject or preheader falls back to the email's. Contacts without a matching version get the email as written. If the automation is on, matching contacts who have not received this email yet get this version. While the automation is on, a version may not hold a placeholder of the template library or print a workspace name that is blank (422 automation_not_ready). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sí | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | sí | Language tag of the version, e.g. fr or pt-br. (max 35 chars) |
subject | string | no | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | no | Inbox preview line. (max 300 chars) |
content | object | no | Block document ({type: "doc", content: [...]}), as the dashboard editor stores it. Sent without html, it is rendered with the workspace design. On an email built in the dashboard's drag-and-drop builder (editor design) it is the builder's project instead: opaque, never write one by hand, and send it back only unchanged together with its html. |
html | string | no | HTML body. The unsubscribe footer is added automatically. |
text | string | no | Cuerpo en texto sin formato. |
{
"name": "set_automation_step_variant",
"arguments": {
"automation_key": "checkout-recovery",
"position": 1,
"locale": "fr",
"subject": "Vous hésitez encore ?",
"html": "<p>Votre panier vous attend.</p>"
}
}set_automation_statusTurn an automation on or off
SENDS REAL EMAIL when status is on: from then on, everyone who enters the automation is emailed on its schedule, within the workspace's sending limits and hours (get_sending_limits), and people already in it continue. Use preview_automation to see who would get which email. Only turn it on when the user asked for this automation to start. Turning on checks an entry, a goal or exit_rules.no_goal, at least one email with a subject and content, no placeholder of the template library such as [First step] or [Link to plans] left in any email (subject, preview text, body, or a link's address), and no blank workspace name that an email prints (422 automation_not_ready with problems, which names each email and detail; get_automation lists the same under to_fill), a sender on a verified domain (403), and an active subscription (402). off stops new entries and sending; people in it stay and continue if it is turned on again, except that an email more than stale_days overdue by then is skipped. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
status | string | sí | on to start sending, off to stop. (one of on, off) |
{
"name": "set_automation_status",
"arguments": {
"automation_key": "checkout-recovery",
"status": "off"
}
}send_automation_test_emailSend one automation email to yourself as a test
SENDS REAL EMAIL: one email of an automation, marked [Test], to the account's own address (get_account -> user.email) and nowhere else; a recipient cannot be given. It is the email as the automation would send it (the language version for locale, the same sender, unsubscribe footer and checks), with stand-in values for its merge tags; sample replaces any of them. A test is not part of the automation: nobody is enrolled, it is in no report, it counts toward nobody's per-person sending limits, it is not tracked, and the automation does not have to be on. It counts toward the workspace's own sending allowance. With dry_run: true nothing is sent and the result is the email as the test would deliver it, with locales and the sample values used. Fails with 422 automation_not_ready when the automation has no sender or the email has no subject or content, and 429 test_limit_reached after 100 test emails in 24 hours. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | sí | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | no | Send the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars) |
sample | object | no | Values to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set. |
dry_run | boolean | no | Send nothing; return the email as the test would deliver it. |
{
"name": "send_automation_test_email",
"arguments": {
"automation_key": "checkout-recovery",
"position": 1
}
}send_automation_testSend every email of an automation to yourself as tests
SENDS REAL EMAIL: every email of an automation, in order, marked [Test 1 of 3], [Test 2 of 3] and so on, to the account's own address (get_account -> user.email) and nowhere else, without waiting for the emails' delays. Rendering, footer, checks and stand-in values are as in send_automation_test_email. A test is not part of the automation: nobody is enrolled, it is in no report, it counts toward nobody's per-person sending limits, it is not tracked, and the automation does not have to be on. It counts toward the workspace's own sending allowance. Nothing is sent unless everything can be: a sender, a subject and content on every email (422 automation_not_ready with problems), and room for all of them under 100 test emails in 24 hours (429 test_limit_reached). If a send is refused after others went out, the rest are not tried and each email's outcome is returned. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
locale | string | no | Send the language version a contact with this language would get (such as fr or pt-br). Omit for the email as written. (max 35 chars) |
sample | object | no | Values to print for merge tags, by key, in place of the stand-ins (first_name is Alex, and so on). email, product_name, and sender_name cannot be set. |
{
"name": "send_automation_test",
"arguments": {
"automation_key": "checkout-recovery"
}
}enroll_contactAdd a contact to an automation
SENDS REAL EMAIL on the automation's schedule: starts the automation for one existing, subscribed contact, counting from anchor_at (now by default). Only call it when the user asked for this person to get this sequence. The automation must be on (409 automation_not_on). Fails with 404 when the email is not a contact (add it with upsert_contact), 422 when the contact cannot be mailed, and 409 when the contact is already in it or went through it before and re-entry is not allowed. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | sí | Email address of an existing contact. (max 320 chars) |
properties | object | no | Up to 50 values (string, number, or boolean; strings are cut at 500 characters), e.g. {"plan": "pro"}. Usable in the automation's emails as merge tags such as {{ plan }}. The names email, name, first_name, last_name, and fields are reserved. |
anchor_at | string | no | The moment the emails' offsets count from, ISO 8601 with a time zone. Defaults to now; may lie ahead for emails that lead up to a date. (max 40 chars) |
{
"name": "enroll_contact",
"arguments": {
"automation_key": "checkout-recovery",
"email": "ada@example.net",
"properties": {
"plan": "pro"
}
}
}exit_contactTake a contact out of an automation
Automations: End a contact's open enrolment in one automation, so no further emails of it are sent to them. Other automations and broadcasts are not affected, and the contact stays subscribed. Fails with 404 when the contact is not in it. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | sí | Email address of the contact. (max 320 chars) |
reason | string | no | Why, for the record (max 200 chars). Defaults to manual. (max 200 chars) |
{
"name": "exit_contact",
"arguments": {
"automation_key": "checkout-recovery",
"email": "ada@example.net",
"reason": "Asked support to stop"
}
}preview_automationPreview what an automation would send now
Automations: A dry run. For the people in the automation now, in the order they come due, what would happen if each were evaluated at this moment. outcome is send (the email in step would go out), scheduled (nothing is due before until), held (the email waits until until; reason is limit_cap, limit_gap, window, or daily_cap), waiting (behind the higher-priority automation in behind), skip (reason is stale, empty_field, or holdout), exit (the contact can no longer be mailed and would leave), complete, blocked (automation_off or subscription_required), or in_progress. Read-only: nothing is sent or changed. Use it before set_automation_status, or after changing limits, to see who gets which email. It applies the automation's own rules and does not foresee a refusal only a real send meets, such as the workspace's daily sending limit or a paused sender. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "preview_automation",
"arguments": {
"automation_key": "checkout-recovery"
}
}get_automations_overviewGet results across all automations
Automations: What every automation of the workspace did in a date range (the last 30 days by default, at most 366 days): totals and one entry per day for people who entered, emails sent, delivered, opened, clicked, and converted (a goal event credited to an email), plus bounces, complaints, unsubscribes, and held (emails made to wait by a limit). Days on which nothing happened are in the series with zeros. domain narrows it to the automations that send from one domain (none: those with no sender yet). Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
from | string | no | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | no | Last day of the report as a UTC date (YYYY-MM-DD), inclusive. |
domain | string | no | Only the automations that send from this domain: the exact domain of their from_address (e.g. example.com), or none for automations with no sender yet. (max 253 chars) |
{
"name": "get_automations_overview",
"arguments": {
"from": "2026-10-20",
"to": "2026-11-18"
}
}get_automation_reportGet the results of one automation
Automations: The results of one automation in a date range (the last 30 days by default, at most 366 days): the same totals and daily series as get_automations_overview, and steps, one row per email with what it sent and what came of it. An email that was removed is listed with archived: true while it still has numbers in the range. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
from | string | no | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | no | Last day of the report as a UTC date (YYYY-MM-DD), inclusive. |
{
"name": "get_automation_report",
"arguments": {
"automation_key": "checkout-recovery"
}
}list_automation_peopleList the people in an automation
Automations: One row per person who did did in an automation, most recent first: entered (the default: everyone who was ever in it), sent, delivered, opened, clicked, converted (their goal was credited to an email), bounced, unsubscribed, or waiting (waiting now behind a higher-priority automation). step narrows every filter except entered and waiting to one email. Each row has the contact's email and name, when they did it, their enrolment's status, and latest: the most recent thing that happened to them in the automation. counts says how many people each filter would list. Read one person's full history with get_automation_person. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
did | string | no | What the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting) |
step | integer | no | Only this email of the automation, by its position. (1–50) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_automation_people",
"arguments": {
"automation_key": "checkout-recovery",
"did": "clicked"
}
}get_automation_personGet one person's history in an automation
Automations: Everything that happened to one contact in an automation: each enrolment and how it ended, each email with when it was sent, delivered, first opened, first clicked, bounced, complained about, or unsubscribed from, every open and click on it (machine: true marks an automated request, which is not counted), and the conversion with the email it was credited to. Fails with 404 for a contact that was never in the automation. Opens and clicks are estimates: each email counts once, at its first open or click by a person, and automated requests (scanners, link previews, privacy prefetching) are never counted. Never claim that a person read an email. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
automation_key | string | sí | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
contact_id | string | sí | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
{
"name": "get_automation_person",
"arguments": {
"automation_key": "checkout-recovery",
"contact_id": "ct_123"
}
}get_sending_limitsGet automation sending limits
Automations: How much automation email one person may get across every automation, and when: at most max_emails in any period_days, at least min_gap_hours apart, only between window_start and window_end (hours in the contact's time zone, or default_timezone) on weekdays (0 = Sunday to 6 = Saturday). An email that would break a limit is not dropped: it waits until the limits allow it. Also product_name and sender_name, available to every automation email as merge tags. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
Sin parámetros.
{
"name": "get_sending_limits",
"arguments": {}
}update_sending_limitsUpdate automation sending limits
Automations: Change the workspace's per-person limits and sending hours for automation email. Omitted keys keep their value. Looser limits mean people can get more email, sooner: confirm with the user before raising max_emails, shortening min_gap_hours, or widening the hours. product_name and sender_name are the names the emails of the template library print; one that an automation that is on prints cannot be cleared (409 workspace_name_in_use). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
max_emails | integer | no | Most automation emails one person may get in period_days. Default 2. (1–50) |
period_days | integer | no | The period max_emails applies to, in days. Default 7. (1–90) |
min_gap_hours | integer | no | Least time between two automation emails to one person, in hours. Default 44. (0–720) |
window_start | integer | no | First hour of the day emails may go out, local time (0-23). Default 9. (0–23) |
window_end | integer | no | Hour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24) |
weekdays | integer[] | no | Days emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items) |
default_timezone | string | no | IANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars) |
product_name | string | no | Your product's name, for {{ product_name }}. (max 120 chars) |
sender_name | string | no | Who the emails are from, for {{ sender_name }}. (max 120 chars) |
{
"name": "update_sending_limits",
"arguments": {
"max_emails": 3,
"min_gap_hours": 24,
"default_timezone": "Europe/London"
}
}list_automation_templatesList automation templates
Automations: The template library: ready-made lifecycle emails to start an automation from instead of writing one. It covers welcome, onboarding tips, a nudge to finish setup (activation), trial ending and trial ended, abandoned checkout, failed payment (dunning), receipt, upgrade at a usage limit, feature announcement, review request, feedback score (NPS), cancellation survey, and winback for retention. Each template has a name, a one-line purpose, the goal it serves (group), its subject, the merge tags it prints, and start: the suggested entry event, the email's wait, and the goal event that ends the automation for a person. sets are templates that arrive together as one automation: three onboarding tips, trial ending then trial ended, and payment failed then a last notice. fill_in lists what only the user knows: placeholders in square brackets such as [First step] or [Link to plans], and the workspace names the email prints. Email bodies are not included; use get_automation_template. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_automation_templates",
"arguments": {}
}get_automation_templateGet an automation template
Automations: One template or one set of the template library, as the draft automation it would make: the suggested start and goal, what the user must fill in, and every email in order with its wait, subject, the email as a block document (content), and preview: the subject and text as this workspace would send them, with sample values for the merge tags. Read it to show the user a welcome, onboarding, trial, abandoned checkout, failed payment (dunning), upgrade, cancellation or winback email before using it. Placeholders such as [First step] are shown as written; a workspace name that is not set reads "Your product" or "Your name" in the preview. Then use_automation_template makes the draft, or set_automation_step with template loads one email into an existing automation. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | Id of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars) |
{
"name": "get_automation_template",
"arguments": {
"template_id": "welcome-note"
}
}use_automation_templateCreate an automation from a template
Automations: Create a draft automation from a template or a set of the library, ready-made: a welcome email, three onboarding tips, a nudge to finish setup, trial ending and trial ended, abandoned checkout, failed payment (dunning) notices, a receipt, an upgrade email at a usage limit, a feature announcement, a review request, a feedback score, a cancellation survey, or a winback for retention. The draft has the emails, the suggested entry event and the suggested goal. Nothing is sent: it stays a draft until set_automation_status turns it on, and that is refused while anything in to_fill is left. to_fill lists each placeholder to replace, by email (ask the user for the real words and links, then use set_automation_step), and each workspace name the emails print that is blank (product_name, sender_name: set with update_sending_limits). Make sure the entry event is one the workspace records (list_event_names); change the start with update_automation. from_address must be on a verified domain. Fails with 404 for an unknown template and 409 when key is taken. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
template_id | string | sí | Id of a template or a set, as returned by list_automation_templates (e.g. welcome-note, checkout-not-finished, payment-failed-notices). (max 63 chars) |
key | string | no | Address of the new automation: 1-63 characters of a-z, 0-9, and -. Defaults to the template's id, with a number added when that is taken. (max 63 chars) |
name | string | no | Name shown in the dashboard. Defaults to the template's own name. (max 200 chars) |
from_name | string | no | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | no | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | no | Reply-To address. (max 320 chars) |
{
"name": "use_automation_template",
"arguments": {
"template_id": "welcome-note",
"name": "Welcome",
"from_name": "Dana from Acme",
"from_address": "dana@example.com"
}
}list_eventsList what contacts did
Automations: The events recorded for the workspace, newest first: who (the contact's id, email, and name), what they did (the event name, and the same as words), when, its properties, where it came from (source.type: api for the workspace's own code, connection with the connection's name, upload for a spreadsheet, system for SendHQ itself), and effects: the automations it started, ended, or converted for that contact. Filter by contact (a contact ID or an email address), name (one event name), and from / to. With contact, the result also lists every automation that contact is or was in (enrollments). An event being recorded does not mean an email was sent: check the automation with list_automation_people. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
contact | string | no | Only this contact: a contact ID or an email address. (max 320 chars) |
name | string | no | Only this event, e.g. checkout_started. See list_event_names. (max 64 chars) |
from | string | no | Events from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars) |
to | string | no | Events up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars) |
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_events",
"arguments": {
"name": "checkout_started",
"from": "2026-11-01"
}
}list_event_namesList the kinds of event recorded
Automations: Every distinct event name recorded in the last 30 days with how many times, the most frequent first, each with the name as words (checkout_started reads checkout started). Use it to see what the workspace is being told about before creating an automation that starts on an event. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_event_names",
"arguments": {}
}list_connectionsList connections
Automations: The workspace's connections. A connection is a secret address another system posts to, such as a payment provider's webhook; what arrives is recorded as events, exactly as track_event records them. Each has its kind (stripe, dodo, or generic), whether it is enabled, whether a signing secret is set, the last four characters of its address, and last_delivery in plain words such as "Recorded 2 events" or "Refused: bad signature". The address and the signing secret are never returned here. Paginated. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_connections",
"arguments": {}
}get_connectionGet a connection and its last deliveries
Automations: One connection with its last 50 deliveries, newest first: when each arrived, whether it was recorded, skipped, or refused and why (text says it in plain words), the sender's own event type, the names of the events recorded, and the contact's email address. Payloads are not stored. Use it to find out why something a provider sent did not show up. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
connection_id | string | sí | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
{
"name": "get_connection",
"arguments": {
"connection_id": "acn_123"
}
}create_connectionCreate a connection
SENDS REAL EMAIL later, when an automation is listening: from the moment the address this returns is given to another system, everything that system posts is recorded as events without anyone looking, and a recorded event starts every automation that is on and starts on it. Only create one when the user asked to connect that system. Returns address once; it cannot be read again, so hand it to the user at once. kind is stripe or dodo (mapped for you: checkout_completed, checkout_abandoned, paid, payment_failed, subscription_started, subscription_renewed, subscription_cancelled, plan_changed) or generic with a mapping. consent_basis is recorded on every contact the connection creates. The provider's signing secret is set by a person in the dashboard or with the REST API, not here. A workspace may have 10 connections (409 connection_limit_reached). Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
name | string | sí | What to call it, e.g. Stripe. (max 80 chars) |
kind | string | sí | stripe, dodo, or generic. (one of generic, stripe, dodo) |
consent_basis | string | sí | How the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars) |
event_prefix | string | no | Put in front of every event name, e.g. stripe_. (max 32 chars) |
enabled | boolean | no | Defaults to true. Pass false to create it switched off. |
mapping | object | no | For a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name. |
mapping.email | string | no | Where the contact's email address is. (max 120 chars) |
mapping.event | string | no | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | no | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | no | Where the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars) |
mapping.id | string | no | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | no | The fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items) |
{
"name": "create_connection",
"arguments": {
"name": "Stripe",
"kind": "stripe",
"consent_basis": "Bought a plan on acme.com and accepted product emails"
}
}update_connectionChange a connection or switch it on or off
SENDS REAL EMAIL later when enabled is set to true: what the connected system posts is recorded as events again, and a recorded event starts every automation that is on and starts on it. Only switch one on when the user asked. Also changes name, consent_basis, event_prefix, or a generic connection's mapping. While enabled is false the address answers 404 and records nothing. The kind cannot be changed. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
connection_id | string | sí | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
name | string | no | A new name. (max 80 chars) |
enabled | boolean | no | true: record what arrives. false: answer 404 and record nothing. |
consent_basis | string | no | How the people this connection tells you about agreed to receive your email, e.g. Bought a plan on acme.com and accepted product emails. Recorded on every contact it creates. 10-500 characters. (max 500 chars) |
event_prefix | string | no | Put in front of every event name, e.g. stripe_. (max 32 chars) |
mapping | object | no | For a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name. |
mapping.email | string | no | Where the contact's email address is. (max 120 chars) |
mapping.event | string | no | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | no | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | no | Where the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars) |
mapping.id | string | no | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | no | The fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items) |
{
"name": "update_connection",
"arguments": {
"connection_id": "acn_123",
"enabled": false
}
}delete_connectionDelete a connection
DESTRUCTIVE: permanently delete a connection with its delivery records. Its address stops working at once, so the system that posts to it starts getting 404 and nothing more is recorded from it. The events it already recorded stay. Confirm with the user first; to pause one instead, use update_connection with enabled: false. Automations are enabled workspace by workspace: a workspace that is not enabled gets 403 automations_not_enabled.
| Parámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
connection_id | string | sí | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
{
"name": "delete_connection",
"arguments": {
"connection_id": "acn_123"
}
}Cuenta, uso, analíticas y claves
get_accountObtener 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.
{
"name": "get_account",
"arguments": {}
}get_account_diagnosticsDiagnose sending and receiving
One read that explains what is wrong with sending or receiving in this workspace: an issues list (unverified domains and missing DKIM records, inbound MX not ready, paused or throttled senders, quota or daily limit reached, trial restrictions, high bounce or complaint rates, failing webhooks), plan and usage against limits, each domain with its DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, and the last 30 days of messages that were not sent (with reasons) plus bounce, complaint and reject events. Start here when a user asks why mail is not arriving. Never returns message bodies or secrets.
Sin parámetros.
{
"name": "get_account_diagnostics",
"arguments": {}
}get_analyticsObtener 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
days | integer | no | Ventana en días: 7, 30 (predeterminado) o 90. (uno de 7, 30, 90) |
{
"name": "get_analytics",
"arguments": {
"days": 30
}
}list_api_keysListar 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ámetro | Tipo | Obligatoria | Descripción |
|---|---|---|---|
limit | integer | no | Tamaño de página. Por defecto, 50. (predeterminado 50; 1–200) |
offset | integer | no | Número de registros que omitir. Use pagination.next_offset de la página anterior. (predeterminado 0; 0–…) |
{
"name": "list_api_keys",
"arguments": {}
}get_service_healthComprobar 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.
{
"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.
| Endpoint | Herramienta | Notas |
|---|---|---|
| POST /emails | send_email | Enviar un correo |
| POST /emails/batch | send_batch | Enviar hasta 100 mensajes personalizados |
| GET /emails | list_emails | Listar el correo enviado y recibido |
| GET /emails/:id | get_email | Obtener un correo y sus adjuntos |
| PATCH /emails/:id | mark_email | Actualizar leído, archivado, spam, categoría o importancia |
| POST /emails/:id/labels | label_email | Agregar o quitar etiquetas de un correo |
| DELETE /emails/:id | delete_email | Eliminar un correo conservado |
| GET /emails/:id/events | list_email_events | Listar los eventos de entrega de un correo |
| GET /threads/:id | get_thread | Obtener una conversación en orden cronológico |
| GET /labels | list_labels | Listar etiquetas con recuentos de mensajes y reglas de archivado |
| POST /labels | create_label | Crear una etiqueta, opcionalmente con reglas de archivado automático |
| GET /labels/:id | get_label | Obtener una etiqueta por ID o nombre |
| PATCH /labels/:id | update_label | Renombrar, cambiar el color o convertir una etiqueta en categoría |
| DELETE /labels/:id | delete_label | Eliminar una etiqueta sin eliminar su correo |
| POST /labels/:id/rules | create_label_rule | Agregar una regla de archivado automático a una etiqueta |
| DELETE /labels/:id/rules/:rule_id | delete_label_rule | Eliminar una regla de archivado automático |
| POST /drafts | create_draft | Crear un borrador del editor |
| GET /drafts | list_drafts | Listar los borradores del editor |
| GET /drafts/:id | get_draft | Obtener un borrador y sus adjuntos |
| PUT /drafts/:id | update_draft | Reemplazar el contenido de un borrador |
| DELETE /drafts/:id | delete_draft | Descartar un borrador |
| POST /drafts/:id/attachments | upload_attachment | Subir un adjunto a un borrador |
| GET /attachments/:id | download_attachment | Descargar un adjunto privado |
| DELETE /attachments/:id | delete_attachment | Eliminar un adjunto privado |
| GET /sending-identities | list_sending_identities | Listar las identidades de remitente verificadas |
| GET /templates | list_templates | Listar plantillas alojadas |
| POST /templates | create_template | Crear una plantilla alojada |
| GET /templates/:id | get_template | Obtener borradores, versiones y uso |
| PUT /templates/:id/draft | update_template_draft | Guardar automáticamente el borrador de una plantilla |
| POST /templates/:id/draft | create_template_draft | Crear un borrador nuevo a partir de la versión publicada |
| POST /templates/:id/render | render_template | Renderizar la salida exacta del servidor |
| POST /templates/:id/test | send_template_test | Enviar una instantánea de prueba |
| POST /templates/:id/publish | publish_template | Publicar una versión inmutable de la plantilla |
| POST /templates/:id/archive | archive_template | Archivar una plantilla |
| POST /templates/:id/restore | restore_template | Restaurar una plantilla archivada |
| POST /domains | add_domain | Agregar un dominio de envío |
| GET /domains | list_domains | Listar dominios y el estado DNS en caché |
| GET /domains/:id | get_domain | Obtener los detalles de configuración de un dominio |
| POST /domains/:id/verify | verify_domain | Refresh domain and DNS verification |
| POST /domains/:id/inbound/setup | setup_inbound | Provision inbound receiving |
| POST /domains/:id/inbound/verify | verify_inbound | Verificar el enrutamiento MX de entrada |
| DELETE /domains/:id | delete_domain | Eliminar un dominio |
| GET /dns/provider | get_dns_provider | Detectar el proveedor de DNS autoritativo y los hosts relativos de los registros |
| GET /dns/domain-connect/connect | get_domain_connect_link | Crear un enlace de consentimiento de Domain Connect para la configuración DNS con un clic |
| POST /inboxes | create_inbox | Crear una dirección de entrada |
| GET /inboxes | list_inboxes | Listar direcciones de entrada |
| GET /inboxes/:id | get_inbox | Obtener una dirección de entrada |
| PATCH /inboxes/:id | update_inbox | Renombrar, habilitar o deshabilitar una bandeja de entrada |
| PUT /inboxes/:id/forwarding | set_inbox_forwarding | Reenviar el correo recibido en una bandeja de entrada a otra dirección |
| DELETE /inboxes/:id | delete_inbox | Eliminar una bandeja de entrada conservando los mensajes |
| GET /deliverability/stats | deliverability_stats | Obtener las estadísticas de entrega de 30 días |
| GET /deliverability/reputation | list_sender_reputation | Listar el estado de reputación por identidad de remitente exacta |
| GET /deliverability/account | deliverability_account | Account delivery rates, daily ladder, and bounce trend |
| GET /deliverability/domains | deliverability_domains | Per-domain sent, delivered, hard and soft bounces, complaints, and failures |
| GET /deliverability/senders | deliverability_senders | Per-From-address delivery rates |
| POST /deliverability/score | score_email | Score an email's content before it is sent |
| GET /emails/:id/delivery | email_delivery | Delivery timeline for one email, with bounce and complaint reasons |
| GET /threads/:id/delivery | thread_delivery | Per-thread delivery counts and per-message failure reasons |
| GET /suppressions | list_suppressions | Listar las supresiones del espacio de trabajo |
| DELETE /suppressions/:email | remove_suppression | Quitar una supresión por rebote que cumpla los requisitos |
| GET /blocked-recipients | list_blocked_recipients | Listar rebotes, quejas y bajas |
| GET /webhooks | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| PATCH /webhooks/:id | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| DELETE /webhooks/:id | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/rotate-secret | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/test | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id/deliveries | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /webhooks/:id/deliveries/:deliveryId | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| POST /webhooks/:id/deliveries/:deliveryId/retry | no expuesto | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| GET /contacts | list_contacts | List contacts |
| POST /contacts | create_contact | Add a contact with its consent basis |
| PUT /contacts | upsert_contact | Create or update a contact by email |
| POST /contacts/bulk | bulk_update_contacts | Tag, move, unsubscribe, or delete many contacts at once |
| GET /contacts/export | no expuesto | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| GET /contacts/:id | get_contact | Retrieve a contact by ID or email |
| PATCH /contacts/:id | update_contact | Update a contact's name, fields, or tags, or unsubscribe it |
| DELETE /contacts/:id | delete_contact | Delete a contact and its list memberships |
| POST /contact-imports | import_contacts | Import contacts from CSV |
| GET /contact-imports | list_contact_imports | List recent contact imports |
| GET /tags | list_tags | List contact tags with how many contacts carry each |
| GET /contact-fields | list_contact_fields | List custom contact field definitions |
| PUT /contact-fields/:key | set_contact_field | Define or change a custom contact field |
| DELETE /contact-fields/:key | delete_contact_field | Delete a custom field definition |
| GET /segments | list_segments | List saved segments with live counts |
| POST /segments | create_segment | Save a segment |
| POST /segments/preview | preview_segment | Count and sample the contacts that match unsaved conditions |
| GET /segments/:id | get_segment | Retrieve a segment and its live count |
| PATCH /segments/:id | update_segment | Rename a segment or change its conditions |
| DELETE /segments/:id | delete_segment | Delete a segment |
| GET /lists | list_lists | List contact lists with member counts |
| POST /lists | create_list | Create a list with an optional signup form, welcome email, and newsletter site |
| GET /lists/:id | get_list | Retrieve a list |
| PATCH /lists/:id | update_list | Rename a list or change its signup form, welcome email, or site |
| DELETE /lists/:id | delete_list | Delete a list without deleting its contacts |
| POST /lists/:id/contacts | add_list_contacts | Add existing contacts to a list |
| DELETE /lists/:id/contacts/:contact_id | remove_list_contact | Remove a contact from a list |
| GET /broadcasts | list_broadcasts | List broadcasts |
| POST /broadcasts | create_broadcast | Create a broadcast draft |
| GET /broadcasts/:id | get_broadcast | Retrieve a broadcast and its delivery totals |
| PATCH /broadcasts/:id | update_broadcast | Edit a draft broadcast |
| DELETE /broadcasts/:id | delete_broadcast | Delete a draft broadcast |
| GET /broadcasts/:id/checks | check_broadcast | Run the pre-send checks for a broadcast |
| POST /broadcasts/:id/test | send_broadcast_test | Send a test copy of a draft |
| POST /broadcasts/:id/schedule | schedule_broadcast | Schedule a draft to send later |
| POST /broadcasts/:id/unschedule | unschedule_broadcast | Unschedule a draft |
| POST /broadcasts/:id/duplicate | duplicate_broadcast | Copy a broadcast into a new draft |
| POST /broadcasts/:id/send | send_broadcast | Send a broadcast to its audience |
| POST /broadcasts/:id/send-more | send_broadcast_to_more | Send a sent broadcast to more of its audience |
| POST /broadcasts/:id/cancel | cancel_broadcast | Cancel a draft or sending broadcast |
| GET /broadcasts/:id/recipients | list_broadcast_recipients | List a broadcast's recipients, outcomes, and engagement |
| GET /broadcasts/:id/report | get_broadcast_report | Retrieve a broadcast's engagement report |
| GET /campaigns/overview | get_campaign_overview | Retrieve subscriber growth and recent broadcast performance |
| GET /newsletter-settings | get_newsletter_settings | Retrieve newsletter settings |
| PATCH /newsletter-settings | update_newsletter_settings | Change newsletter settings |
| POST /uploads/images | no expuesto | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| GET /uploads/images | list_uploaded_images | List recently uploaded images |
| POST /events | track_event | Record something a contact did |
| POST /events/batch | no expuesto | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| GET /automations | list_automations | List automations with their 30-day totals |
| POST /automations | create_automation | Create an automation as a draft |
| GET /automations/:key | get_automation | Retrieve an automation with its emails |
| PATCH /automations/:key | update_automation | Edit an automation |
| DELETE /automations/:key | delete_automation | Delete an automation and its history |
| PUT /automations/:key/steps/:position | set_automation_step | Create or change one email of an automation |
| DELETE /automations/:key/steps/:position | delete_automation_step | Remove one email from an automation |
| PUT /automations/:key/steps/:position/variants/:locale | set_automation_step_variant | Create or change a language version of an email |
| POST /automations/:key/steps/:position/test | send_automation_test_email | Send one email of an automation to yourself as a test |
| POST /automations/:key/test | send_automation_test | Send every email of an automation to yourself as tests |
| POST /automations/:key/status | set_automation_status | Turn an automation on or off |
| POST /automations/:key/enroll | enroll_contact | Add a contact to an automation |
| POST /automations/:key/exit | exit_contact | Take a contact out of an automation |
| GET /automations/:key/preview | preview_automation | Dry run: what each person in an automation would get now |
| GET /automations/overview | get_automations_overview | Totals and a daily series across every automation |
| GET /automations/:key/report | get_automation_report | Results of one automation, with one row per email |
| GET /automations/:key/people | list_automation_people | List the people in an automation by what they did |
| GET /automations/:key/people/:contact_id | get_automation_person | One person's history in an automation |
| POST /automations/:key/import-history | no expuesto | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| GET /automation-settings | get_sending_limits | Retrieve the workspace's sending limits for automations |
| PUT /automation-settings | update_sending_limits | Change the workspace's sending limits for automations |
| GET /automation-library | list_automation_templates | List the template library: ready-made lifecycle emails |
| GET /automation-library/:id | get_automation_template | Read one template or set, with the email as it will look |
| POST /automation-library/:id/use | use_automation_template | Create a draft automation from a template or set |
| GET /events | list_events | List what contacts did, newest first |
| GET /events/names | list_event_names | List the kinds of event recorded in the last 30 days |
| POST /events/preview | no expuesto | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
| GET /connections | list_connections | List the workspace's connections (incoming webhooks) |
| POST /connections | create_connection | Create a connection and get its address |
| POST /connections/test | no expuesto | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
| GET /connections/:id | get_connection | Retrieve a connection with its last deliveries |
| PATCH /connections/:id | update_connection | Change a connection or switch it on or off |
| DELETE /connections/:id | delete_connection | Delete a connection |
| POST /connections/:id/address | no expuesto | The address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings. |
| GET /account | get_account | Obtener la cuenta, el uso, el estado de facturación y los recuentos del espacio de trabajo con una clave de API |
| GET /account/diagnostics | get_account_diagnostics | Diagnose sending and receiving problems in the workspace |
| GET /analytics | get_analytics | Obtener las analíticas de envío del panel de 7, 30 o 90 días |
| GET /profile | get_account | Gemelo de GET /account solo para sesiones; el servidor MCP lee la ruta con clave de API. |
| POST /billing/checkout | no expuesto | Por 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/cancel | no expuesto | Por 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 /keys | no expuesto | Excluido deliberadamente: un agente no debe emitir ni destruir credenciales. Las claves las gestiona una persona en el panel. |
| GET /keys | list_api_keys | Listar los metadatos de las claves de API |
| DELETE /keys/:id | no expuesto | Excluido deliberadamente: un agente no debe emitir ni destruir credenciales. Las claves las gestiona una persona en el panel. |
No disponible deliberadamente
| Capacidad | Endpoints | Motivo |
|---|---|---|
| Crear, rotar, revocar o eliminar claves de API | POST /keys, DELETE /keys/:id | Excluido 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ón | POST /billing/checkout, POST /billing/cancel | Por 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/connect | Requiere 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 soporte | POST /api/contact | Formulario público del sitio de marketing para personas, no una operación del espacio de trabajo. |
| Webhook endpoints and deliveries | GET /webhooks, POST /webhooks, GET /webhooks/:id, PATCH /webhooks/:id, DELETE /webhooks/:id, POST /webhooks/:id/rotate-secret, POST /webhooks/:id/test, GET /webhooks/:id/deliveries, GET /webhooks/:id/deliveries/:deliveryId, POST /webhooks/:id/deliveries/:deliveryId/retry | Webhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients. |
| Upload editor images and export contacts as CSV | POST /uploads/images, GET /contacts/export | Image uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated). |
| Import an automation's send history and record events in bulk | POST /automations/:key/import-history, POST /events/batch | History import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries. |
| Move SendHQ's own win-back emails onto automations (backfill and comparison) | POST /automations/platform-backfill, GET /automations/platform-compare | Internal cutover tools for SendHQ's own workspace only: they answer nobody else, need its owner's dashboard session, and are not part of the public API or of /api/v1. The backfill enrols SendHQ's own accounts, so it is run by a person, one page at a time, after reading the dry run. |
| Replace a connection's secret address | POST /connections/:id/address | The address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings. |
| Dry runs for a sample payload and for a set of events | POST /connections/test, POST /events/preview | These answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events. |
Catálogo 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.