Pour les agents IA
Serveur MCP SendHQ
Give an AI agent full, safe control of one SendHQ workspace: send and receive email, verify domains, publish templates, and investigate deliverability through 142 strictly typed tools. Written for agents first; humans welcome.
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
claude mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcpPrésentation du serveur
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.
C’est un serveur stdio local intégré au binaire CLI sendhq. Votre client MCP lance sendhq mcp comme processus enfant et communique en JSON-RPC via stdin/stdout. Chaque appel d’outil devient une requête documentée vers l’API REST de SendHQ à l’adresse https://sendhq.cc/api/v1, authentifiée avec la clé API de votre espace de travail : le serveur MCP a donc exactement les permissions de cette clé, et rien de plus.
- 142 tools in 10 groups, generated from one catalog that is also published as tools.json.
- Des JSON Schemas stricts : les arguments inconnus, les types incorrects et les champs obligatoires manquants sont rejetés localement avant que quoi que ce soit n’atteigne SendHQ.
- Des erreurs structurées avec un
codestable, lestatusHTTP, uneexplanation, unremedyconcret et l’indication qu’une nouvelle tentative peut ou non aider. - Chaque outil qui envoie de vrais e-mails ou détruit des données l’indique dès les premiers mots de sa description et porte des annotations de sécurité MCP.
- Le mode
--read-onlymasque tous les outils d’envoi et de modification. - Rien n’est journalisé. stdout ne transporte que des messages de protocole ; la clé API et le contenu des messages n’apparaissent jamais dans un log.
https://sendhq.cc/api/mcp (consultation des tarifs et de la documentation, sans accès au compte). Le serveur décrit sur cette page est le serveur complet, rattaché au compte ; il s’exécute en local ou via le connecteur hébergé décrit ci-dessous.Use SendHQ in Claude, ChatGPT and Grok
Aucune installation requise : SendHQ exécute aussi ce serveur sous forme de connecteur hébergé à l’adresse https://mcp.sendhq.cc/mcp, avec les mêmes outils. Vous vous connectez avec votre compte SendHQ au lieu de coller une clé.
Claude
- Ouvrez Settings → Connectors et trouvez SendHQ dans l’annuaire, ou choisissez Add custom connector et collez
https://mcp.sendhq.cc/mcp. - Cliquez sur Connect, connectez-vous à SendHQ, vérifiez les accès demandés et cliquez sur Allow.
- Demandez à Claude de consulter votre boîte de réception, d’envoyer un e-mail depuis votre domaine vérifié ou d’expliquer un bounce.
ChatGPT
- Open Settings → Security and login and turn on Developer mode.
- Go to chatgpt.com/plugins, click Create MCP app, name it SendHQ and enter
https://mcp.sendhq.cc/mcp. - Sign in to SendHQ and click Allow, then pick SendHQ from the tools menu in a new chat.
Grok
- Go to grok.com/connectors, click New Connector, then Custom.
- Enter
https://mcp.sendhq.cc/mcp, sign in to SendHQ and click Allow.
Muse by Meta
In Muse, open Connectors and search for SendHQ. Click Connect, sign in to SendHQ and click Allow.
Approbation et déconnexion
- The
request_featuretool sends a feature request to the SendHQ team with your account details, so we can follow up by email. - Les outils qui envoient de vrais e-mails ou suppriment des données sont signalés comme tels. C’est dans l’assistant que vous choisissez, outil par outil, s’il doit d’abord vous demander votre accord : dans Claude, choisissez Needs approval pour ces outils sous Settings → Connectors → SendHQ.
- Le connecteur reçoit sa propre clé API, nommée d’après l’assistant (par exemple « Claude (AI connector) »). Supprimez-la sous API Keys pour le déconnecter immédiatement.
- Il ne peut ni créer ni révoquer de clés API, ni modifier la facturation. Les pièces jointes sont envoyées et renvoyées en base64 ; il n’y a aucun accès aux fichiers locaux.
- Sending requires an active subscription. There is no free allowance, including mail to the account owner.
Questions : postmaster@sendhq.cc. Confidentialité : sendhq.cc/privacy.
Installation
Installez le binaire sendhq (Linux, macOS et Windows, sur x86-64 et arm64). L’installateur vérifie la somme de contrôle de la version et place le binaire dans ~/.local/bin par défaut.
curl -fsSL https://downloads.sendhq.cc/install.sh | shirm https://downloads.sendhq.cc/install.ps1 | iexsendhq version
SENDHQ_API_KEY=re_your_key sendhq doctorCréez une clé API dans le tableau de bord, à l’adresse https://sendhq.cc/app#/keys. Le serveur MCP ne peut pas créer de clés. La seule commande qui lance le serveur est :
SENDHQ_API_KEY=re_your_key sendhq mcpEn temps normal, vous ne la lancez jamais à la main : c’est le client MCP qui s’en charge. Lancée dans un terminal, elle attend du JSON-RPC sur stdin.
Configurer votre client
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-onlyAjoutez --scope user pour le rendre disponible dans tous les projets, ou --scope project pour l’écrire dans le fichier .mcp.json du projet. Pour un .mcp.json partagé, référencez la clé depuis l’environnement au lieu de la committer ; Claude Code développe ${VAR} dans .mcp.json.
{
"mcpServers": {
"sendhq": {
"command": "sendhq",
"args": [
"mcp"
],
"env": {
"SENDHQ_API_KEY": "${SENDHQ_API_KEY}"
}
}
}
}OpenAI Codex
[mcp_servers.sendhq]
command = "sendhq"
args = ["mcp"]
env = { SENDHQ_API_KEY = "re_your_key" }Ou en ligne de commande : codex mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp.
Claude Desktop
Modifiez claude_desktop_config.json (macOS : ~/Library/Application Support/Claude/, Windows : %APPDATA%\Claude\) et redémarrez l’application. Les applications de bureau n’héritent pas du PATH de votre shell : utilisez donc le chemin absolu du binaire (which sendhq).
{
"mcpServers": {
"sendhq": {
"command": "/Users/you/.local/bin/sendhq",
"args": [
"mcp"
],
"env": {
"SENDHQ_API_KEY": "re_your_key"
}
}
}
}Tout autre client MCP
Configurez un serveur stdio avec la commande sendhq, les arguments ["mcp"] (et éventuellement "--read-only") et les variables d’environnement ci-dessous. Le serveur prend en charge les versions 2024-11-05, 2025-03-26, 2025-06-18 et 2025-11-25 du protocole MCP, et implémente initialize, ping, tools/list et tools/call. Les résultats d’outils contiennent à la fois un bloc de texte JSON et un 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":{}}}Il n’existe pas de transport HTTP hébergé pour le serveur rattaché au compte. Un endpoint MCP distant capable d’écrire nécessiterait un OAuth par utilisateur, que SendHQ ne propose pas ; le binaire local garde la clé sur la machine qui la détient déjà.
Environnement et options
| Variable ou option | Obligatoire | Signification |
|---|---|---|
SENDHQ_API_KEY | oui | Clé API de l’espace de travail (re_…). Tous les outils sauf get_service_health en ont besoin. Sans elle, le serveur démarre quand même et chaque appel renvoie une auth_error structurée expliquant comment corriger le problème. |
SENDHQ_API_BASE_URL | non | URL de base de l’API. Valeur par défaut : https://sendhq.cc/api/v1. À n’utiliser que pour un déploiement local ou de staging. SENDHQ_BASE_URL est accepté comme ancien alias. |
SENDHQ_MCP_READ_ONLY | non | 1, true ou yes équivaut à --read-only. |
--read-only | non | N’expose que les outils qui n’envoient pas d’e-mails et ne modifient pas l’état. Les outils masqués sont également refusés s’ils sont appelés par leur nom. |
SENDHQ_PROFILE / --profile | non | Utilise une clé enregistrée par sendhq auth login dans le trousseau du système d’exploitation au lieu de SENDHQ_API_KEY. La variable d’environnement l’emporte si les deux existent. |
La clé n’est envoyée que dans l’en-tête Authorization: Bearer, vers l’URL de base configurée. Elle n’est jamais affichée, journalisée, reprise dans les erreurs ni incluse dans les résultats d’outils.
Modèle de sécurité pour les agents
- 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. - Modifie l’état. Créer ou mettre à jour des brouillons, des modèles, des domaines et des boîtes de réception, publier des modèles et lancer une vérification modifient l’espace de travail, mais n’envoient pas d’e-mail.
- Lecture seule. Tout le reste est
readOnlyHint: trueet peut être appelé librement. - Ce serveur ne modifie jamais le DNS.
add_domainrenvoie des enregistrements qu’un humain doit publier ;get_domain_connect_linkrenvoie une URL de consentement qu’une personne doit ouvrir et approuver chez son fournisseur DNS. - Ce serveur ne modifie jamais la facturation.
get_accountse contente de lire la formule, l’utilisation et l’état de l’abonnement. - 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). - Ne changez pas d’adresse From pour contourner une pause
423, et ne réintégrez jamais des destinataires désinscrits ou ayant porté plainte.
Les clés API sont hors périmètre
Par conception, il n’existe aucun outil pour créer, modifier, faire tourner, révoquer ou supprimer des clés API. Un agent ne doit ni émettre ni détruire d’identifiants. list_api_keys renvoie uniquement les noms, les préfixes non secrets et les dates de dernière utilisation. La gestion des clés reste dans le tableau de bord, entre les mains d’un humain connecté.
Workflows
1. Premier envoi
get_service_healthconfirme que l’API est joignable (fonctionne sans clé).get_accountshows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returnssubscription_required.list_sending_identitiesliste les adresses From que vous pouvez utiliser. Si la liste est vide, suivez d’abord le workflow de domaine.- Confirmez l’expéditeur, le destinataire, l’objet et le corps avec l’utilisateur, puis appelez
send_emailavec uneidempotency_key. list_email_eventsavec l’idrenvoyé affichedelivery,bounce,complaintourejectdès que le fournisseur le signale (généralement en quelques secondes à quelques minutes).
{
"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. Vérification de domaine de bout en bout
add_domainwithname: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).get_dns_provideravec ledomain_iddétecte le fournisseur DNS faisant autorité et renvoie l’hôte relatif exact à saisir pour chaque enregistrement chez ce fournisseur.- 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.- Lorsque
statusvautverified, les adresses du domaine apparaissent danslist_sending_identities.
3. Bounces, plaintes et suppressions
list_blocked_recipientsrenvoie chaque adresse bloquée avec son motif (bounce,complaint,unsubscribe) ainsi qu’un décompte récapitulatif.list_suppressionsrenvoie les suppressions pour hard bounce et pour plainte ;deliverability_statsfournit les taux de livraison, de bounces et de plaintes sur 30 jours ;list_sender_reputationindique quelles adresses From sont bridées ou en pause.- Un envoi contenant un destinataire en liste de suppression échoue avec
422 recipient_suppressed. Retirez ce destinataire et renvoyez. - N’appelez
remove_suppressionque lorsqu’un humain confirme qu’une boîte aux lettres en bounce fonctionne désormais. Les suppressions pour plainte sont permanentes (409 complaint_suppression_locked).
4. Recevoir des e-mails entrants
- Le domaine (souvent un sous-domaine comme
inbound.example.com) doit être vérifié. setup_inboundconfigure la réception et renvoie un enregistrement MX. Un humain le publie.verify_inboundjusqu’à ce questatusvailleready.create_inboxavecdomain_idetlocal_part(par exemplesupport) créesupport@inbound.example.com.- Interrogez
list_emailsavecdirection: "in"etunread: true(et éventuellementinbox_id). Lisez un message avecget_email, sa conversation avecget_thread, ses pièces jointes avecdownload_attachment, et marquez-le comme traité avecmark_email(read: true). - Répondez dans le fil avec
send_emailetreply_to_email_id; SendHQ définit In-Reply-To, References et le fil de discussion.
5. Webhooks et notifications d’événements
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. Diagnostiquer un échec de livraison
- Trouvez le message :
list_emailsavecdirection: "out"ettoouquery, ouget_emailsi vous avez l’identifiant.status: failedsignifie que SendHQ ou le fournisseur l’a rejeté lors de la soumission ; l’erreur de l’e-mail en explique la raison. list_email_events:bounce(permanent ou transitoire, avec le diagnostic du fournisseur),complaint,rejectoudelivery. L’absence d’événements signifie que le fournisseur n’a encore rien signalé ; attendez et vérifiez à nouveau.- 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_domainvérifie que DKIM, SPF et DMARC sont toujours publiés ;deliverability_statsmontre si le problème concerne un seul message ou une tendance.- Rapportez ce que montrent les preuves. Un événement
deliverysignifie que le serveur du destinataire a accepté le message, pas qu’il est arrivé en boîte de réception ni qu’il a été lu.
7. Gérer sa propre catégorie de tâches (libellés)
create_labelavecname(par exempleAgent/Orders) etskip_inbox: true. Le libellé devient alors une catégorie : le courrier reçu qui l’obtient est archivé, de sorte qu’il n’apparaît que dans le libellé, jamais dans la Boîte de réception de l’humain.- Envoyez le courrier lié à la tâche avec
send_email(ousend_batch) etlabels: ["Agent/Orders"]. Les réponses à cette conversation héritent automatiquement du libellé et évitent la Boîte de réception. - Pour le courrier qui commence en dehors de vos conversations, ajoutez une règle de classement :
create_label_ruleavecinbox_id(une adresse dédiée commeorders@…),from,toousubject. Passezapply_to_existing: truepour classer le courrier déjà reçu. - Traitez la catégorie :
list_emailsaveclabel: "Agent/Orders",direction: "in"etunread: true; lisez avecget_emailouget_thread, répondez avecsend_emailetreply_to_email_id, puis appelezmark_emailread: trueune fois le message traité. - Déplacez un message égaré vers la catégorie ou hors de celle-ci avec
label_email(add/remove). Ajouter un libellé de catégorie à un message reçu l’archive également. - En option,
set_inbox_forwardingenvoie une copie de tout ce que reçoit une adresse de réception vers une autre boîte aux lettres (la cible confirme d’abord par e-mail).
{
"name": "send_email",
"arguments": {
"from": "Orders <orders@example.com>",
"to": [
"customer@example.net"
],
"subject": "Order 1042: confirm delivery window",
"text": "Reply with a time that works.",
"labels": [
"Agent/Orders"
],
"idempotency_key": "order-1042-window"
}
}8. Pièces jointes et modèles
Joignez jusqu’à 10 fichiers avec le paramètre attachments de send_email (chacun nécessite content_base64 ou un file_path local ; filename vaut par défaut le nom de base du fichier) sur une formule payante. Pour les modèles hébergés : create_template → update_template_draft → render_template pour prévisualiser avec des données d’exemple → send_template_test (envoie un vrai test) → publish_template, puis envoyez avec send_email ou send_batch en utilisant template: {key, data} et exactement un destinataire 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>"
}
}Résultats, pagination et erreurs
Un appel réussi renvoie l’objet JSON de l’API sous forme de structuredContent et de bloc de texte JSON. Chaque outil list_* accepte limit (1–200, 50 par défaut) et offset, et ajoute un objet pagination. Continuez à appeler avec offset: pagination.next_offset tant que has_more vaut true.
{
"data": [
"…"
],
"count": 50,
"pagination": {
"offset": 0,
"limit": 50,
"returned": 50,
"total": 180,
"has_more": true,
"next_offset": 50
}
}Un appel en échec renvoie isError: true avec une erreur structurée. Suivez le remedy au lieu de réessayer à l’aveugle ; ne réessayez que si retryable vaut 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."
}
}Champs d’erreur facultatifs : request_id (à citer au support), retry_after_seconds, problems (liste des violations de schéma pour invalid_arguments) et idempotent_replayed (voir Idempotence).
Idempotence
send_email et send_batch acceptent idempotency_key (200 caractères max.), envoyée dans l’en-tête Idempotency-Key. Générez une clé stable par message logique, par exemple invoice-4812-receipt.
- Une nouvelle tentative doit réutiliser la même clé ET un corps de requête identique. La même clé avec la moindre modification (destinataire, objet, corps, en-tête, données de modèle, voire valeurs d’arguments) renvoie
409 idempotency_conflict. - Même clé, même corps, requête d’origine terminée : SendHQ renvoie le résultat enregistré sans renvoyer l’e-mail. C’est ainsi que l’on réessaie sans risque après un timeout ou une
network_error. - Même clé alors que la requête d’origine est encore en cours :
409 idempotency_in_progress, à réessayer après une courte attente. - Un nouveau message logique nécessite une nouvelle clé.
- Les échecs enregistrés sont eux aussi rejoués. Si la première tentative a échoué, réessayer avec la même clé renvoie ce même échec avec
idempotent_replayed: trueetretryable: false. Vérifiez aveclist_emails(direction: out) que rien n’est parti, corrigez la cause, puis envoyez avec une nouvelle clé. - Le serveur ne réessaie jamais un POST de lui-même. Seuls les appels GET en lecture seule sont réessayés automatiquement (jusqu’à 3 tentatives en cas d’erreur réseau, de 429 et de 5xx).
send_emailavec desattachmentsen ligne ne peut pas prendre d’idempotency_key, car il exécute plusieurs requêtes. Pour des envois de pièces jointes sûrs en cas de nouvelle tentative :create_draft→upload_attachment→send_emailavecdraft_idetidempotency_key.
{
"name": "send_email",
"arguments": {
"from": "Acme <billing@example.com>",
"to": [
"owner@example.com"
],
"subject": "Receipt #4812",
"text": "Thanks for your payment.",
"idempotency_key": "receipt-4812"
}
}Limites de débit et quotas
SendHQ ne publie pas de limite fixe de requêtes par seconde pour l’API. Les limites qu’un agent rencontre réellement sont des limites d’utilisation, renvoyées sous forme de 429 :
- Livraisons mensuelles par destinataire selon la formule. Chaque adresse To, Cc et Bcc compte pour une livraison. Voir
get_account→usage.recipientDeliveriespar rapport àusage.emailQuotaMonth. - Destinataires quotidiens par adresse From exacte, selon l’état de réputation de cet expéditeur (
list_sender_reputation→dailyLimit, 2 000 par défaut sur les formules payantes). - 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. - Pièces jointes : au maximum 10 fichiers et 10 MB par message ; 10 GB de transfert de pièces jointes pondéré par destinataire par mois sur les formules payantes.
- Par requête : To + Cc + Bcc jusqu’à 100 adresses ;
send_batchjusqu’à 100 messages. - Disjoncteur de réputation : sur une fenêtre glissante de 7 jours, des bounces ou des plaintes au-delà du seuil brident ou mettent en pause une adresse From (
423 sender_paused). Elle se rétablit automatiquement une fois les taux redescendus.
quota_exhausted ne peut pas être réessayé avant la réinitialisation de la période ou un changement de formule. rate_limited peut être réessayé après retry_after_seconds ; pour les envois, réessayez avec la même idempotency_key et un corps identique.
Catalogue des erreurs
Le code est stable ; basez vos branchements sur lui plutôt que sur message.
| code | HTTP | Réessayer ? | Signification et marche à suivre |
|---|---|---|---|
invalid_arguments | — | non | Les arguments n’ont pas passé localement le JSON Schema de l’outil ; rien n’a atteint SendHQ. Corrigez les champs listés dans problems. |
auth_error | 401 | non | Clé API manquante, révoquée ou incorrecte. Définissez SENDHQ_API_KEY pour le processus du serveur ; c’est un humain qui crée les clés dans le tableau de bord. |
subscription_required | 402 | non | No active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then. |
payment_required | 402 | non | La fonctionnalité nécessite une formule payante (par exemple les pièces jointes). Envoyez sans elle ou passez à une formule supérieure. |
sender_domain_not_owned | 403 | non | Le domaine From n’appartient pas à cet espace de travail. Utilisez list_sending_identities ou add_domain. |
sender_domain_unverified | 403 | non | Le domaine From n’est pas encore vérifié. get_domain, publiez les enregistrements manquants, verify_domain. |
domain_limit_reached | 403 | non | Limite de domaines de la formule atteinte. Supprimez un domaine inutilisé (avec approbation) ou passez à une formule supérieure. |
marketing_not_enabled | 403 | non | La classe marketing n’est pas activée pour ce domaine ou cette formule. N’utilisez transactional que si le message est réellement transactionnel. |
forbidden | 403 | non | La politique n’autorise pas l’opération. Ajustez la requête. |
not_found | 404 | non | L’identifiant n’appartient pas à cet espace de travail. Listez la ressource pour trouver le bon identifiant ; restaurez d’abord les modèles archivés. |
idempotency_conflict | 409 | non | Clé réutilisée avec un corps différent. Renvoyez exactement la requête d’origine, ou utilisez une nouvelle clé pour un nouveau message. |
idempotency_in_progress | 409 | oui | La requête d’origine est toujours en cours. Attendez, puis réessayez avec la même clé et le même corps. |
revision_conflict | 409 | non | Le brouillon du modèle a changé depuis votre lecture. get_template, fusionnez, enregistrez à nouveau. |
complaint_suppression_locked | 409 | non | Le destinataire a porté plainte. Ne lui envoyez plus jamais d’e-mail. |
inbound_not_ready | 409 | non | La réception n’est pas prête. setup_inbound, publiez le MX, verify_inbound. |
conflict | 409 | non | La ressource existe déjà ou n’est pas dans le bon état. Lisez-la et ajustez. |
attachments_too_large | 413 | non | Plus de 10 fichiers ou de 10 MB. Retirez ou réduisez les pièces jointes. |
recipient_suppressed | 422 | non | Un destinataire a déjà généré un hard bounce ou une plainte. Retirez-le ; voir list_blocked_recipients. |
recipient_unsubscribed | 422 | non | Un destinataire s’est désinscrit des e-mails marketing. Retirez-le définitivement. |
validation_failed | 422 | non | Contenu rejeté, par exemple des données de modèle qui ne respectent pas le contrat de variables. Corrigez l’entrée. |
sender_paused | 423 | non | Cette adresse From est mise en pause par le disjoncteur bounces/plaintes sur 7 jours. Arrêtez, corrigez la liste et attendez le rétablissement automatique. |
account_paused | 423 | non | 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 | non | 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 | oui | Slow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap. |
server_error | 5xx | oui | Défaillance temporaire de SendHQ ou du fournisseur. Appliquez un backoff et réessayez ; pour les envois, avec la même clé et le même corps. Si idempotent_replayed vaut true, utilisez une nouvelle clé après avoir confirmé que rien n’a été envoyé. |
network_error | — | oui | Requête ou réponse perdue. Réessayez ; pour les envois, la même idempotency_key rend l’opération sûre. |
invalid_request | 400 | non | Requête mal formée. Lisez message et corrigez-la. |
tool_error | — | non | Défaillance locale dans le serveur MCP (par exemple un file_path illisible). Lisez message. |
Référence des outils
Chaque outil avec sa classe de sécurité, l’endpoint REST qu’il appelle, ses paramètres, son format de retour et un exemple d’objet params pour tools/call. Les paramètres sont exacts : le serveur rejette tout ce qui n’est pas listé.
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
Aucun outil ne correspond à ce filtre.
E-mails et fils de discussion
send_emailEnvoyer un e-mail
SENDS REAL EMAIL. Send one message from a verified domain: raw html/text, a published hosted template, a reply in an existing thread, or a message with attachments. Pass idempotency_key so a retry cannot send twice; a retry must reuse the same key AND an identical request, otherwise SendHQ returns 409. attachments is a convenience that creates a draft, uploads each file, and sends with that draft; it cannot be combined with idempotency_key or draft_id (use create_draft + upload_attachment + send_email with draft_id for retry-safe attachment sends). Unpaid workspaces (integration trial) can deliver only to the account email or a mailbox-simulator test address, and cannot send attachments.
Fournissez au moins l’un des éléments suivants : html, text, template.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
from | string | oui | Expéditeur, par ex. Acme <hello@example.com>. Le domaine doit être vérifié dans cet espace de travail (voir list_sending_identities). (998 caractères max.) |
to | string[] | oui | Destinataires. Chaque entrée est une adresse, éventuellement accompagnée d’un nom d’affichage. To+cc+bcc ne peuvent dépasser 100 au total ; chaque destination consomme un crédit de livraison. (1–100 éléments) |
cc | string[] | non | Destinataires en copie. (0–100 éléments) |
bcc | string[] | non | Destinataires en copie cachée. (0–100 éléments) |
subject | string | non | Objet. À omettre lors de l’envoi d’un modèle. (998 caractères max.) |
text | string | non | Corps en texte brut. Fournissez text, html ou template. |
html | string | non | Corps HTML. SendHQ le nettoie et en dérive le texte lorsque text est omis. |
reply_to | string | non | Adresse Reply-To. |
headers | object | non | En-têtes personnalisés sûrs supplémentaires (valeurs de type chaîne), par ex. {"X-Entity-Ref-ID": "123"}. Les en-têtes de routage comme From/To/Message-ID sont contrôlés par SendHQ. |
message_class | string | non | transactional (par défaut) ou marketing. Le mode marketing nécessite une formule ou un domaine où le marketing est activé, et ajoute la gestion des désinscriptions. (valeurs possibles : transactional, marketing) |
reply_to_email_id | string | non | Répondre dans une conversation existante : l’identifiant em_… du message auquel vous répondez. SendHQ définit In-Reply-To/References et le fil de discussion. |
thread_id | string | non | Identifiant explicite du fil sous lequel classer le message. |
draft_id | string | non | Envoie avec ce message les pièces jointes d’un brouillon enregistré (dr_…). Le brouillon est supprimé après un envoi réussi. |
template | object | non | Envoie un modèle hébergé publié au lieu de html/texte brut. Exige exactement un destinataire to et aucun cc/bcc ; le modèle fournit l’objet. Fournissez au moins l’un des éléments suivants : id, key. |
template.id | string | non | Identifiant du modèle (tmpl_…). Fournissez id ou key. |
template.key | string | non | Clé du modèle, par exemple account-welcome. Fournissez id ou key. |
template.version_id | string | non | Identifiant facultatif d’une version publiée (tmplv_…). Par défaut, la version publiée actuelle. |
template.data | object | non | Valeurs des variables typées du modèle. |
labels | string[] | non | Noms de libellés ou identifiants lbl_… sous lesquels classer ce message. Les noms inconnus sont créés. Les réponses de la conversation héritent des libellés, et un libellé de catégorie (skip_inbox) tient ces réponses hors de la Boîte de réception. 10 max. (0–10 éléments) |
idempotency_key | string | non | En-tête Idempotency-Key (200 caractères max.). Ne la réutilisez que pour réessayer exactement cette requête. (200 caractères max.) |
attachments | object[] | non | Fichiers à joindre (10 fichiers max., 10 MB au total). Chacun nécessite content_base64 (plus filename) ou un file_path local. (0–10 éléments) Fournissez au moins l’un des éléments suivants : content_base64, file_path. |
attachments[].filename | string | non | Nom de fichier affiché au destinataire. Obligatoire avec content_base64 ; par défaut, le nom de base de file_path. (255 caractères max.) |
attachments[].content_type | string | non | Type MIME, par ex. application/pdf. Par défaut application/octet-stream. |
attachments[].content_base64 | string | non | Contenu du fichier en base64 standard. |
attachments[].file_path | string | non | Chemin absolu d’un fichier local lisible par le processus du serveur MCP. |
{
"name": "send_email",
"arguments": {
"from": "Acme <hello@example.com>",
"to": [
"owner@example.com"
],
"subject": "Your export is ready",
"text": "Download it from your dashboard.",
"idempotency_key": "export-ready-42"
}
}send_batchEnvoyer un lot d’e-mails personnalisés
SENDS REAL EMAIL. Envoie de 1 à 100 messages indépendants en une seule requête (à utiliser pour la personnalisation de modèle par destinataire). Chaque élément a la même forme que send_email (sans attachments/idempotency_key). Les éléments réussissent ou échouent individuellement : HTTP 207 signifie un succès partiel ; examinez chaque data[i].ok et data[i].error. Une seule idempotency_key couvre l’ensemble du corps du lot.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
emails | object[] | oui | Messages à envoyer. (1–100 éléments) Fournissez au moins l’un des éléments suivants : html, text, template. |
idempotency_key | string | non | Idempotency-Key pour l’ensemble du lot (200 caractères max.). (200 caractères max.) |
{
"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_emailsLister et rechercher des e-mails
Liste les e-mails envoyés (direction: out) et reçus (direction: in), du plus récent au plus ancien, avec filtres. Le courrier reçu est classé : lisez la boîte de réception humaine avec direction: in, archived: false, category: primary ; faites le tri avec important: true ; le spam est masqué sauf avec category: spam ou include_spam: true. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
direction | string | non | in pour le courrier reçu, out pour le courrier envoyé. (valeurs possibles : in, out) |
status | string | non | Filtre de statut, par ex. queued, sent, delivered, bounced, complained, failed. |
domain | string | non | Uniquement les messages de ce domaine, ou d’une liste de domaines séparés par des virgules (correspondance avec n’importe lequel). |
inbox_id | string | non | Uniquement les messages reçus par cette boîte de réception (inb_…). |
label | string | non | Uniquement les messages portant ce libellé : un identifiant de libellé lbl_… ou son nom exact, ou une liste séparée par des virgules (correspondance avec n’importe lequel). Utilisez list_labels pour voir les dossiers. |
archived | boolean | non | false = vue Boîte de réception (courrier reçu non archivé), true = courrier archivé uniquement. À omettre pour tout le courrier. |
category | string | non | primary (personnes), updates (newsletters, envois en masse, e-mails automatisés) ou spam ; ou une liste séparée par des virgules. Le spam est masqué sauf demande explicite. |
important | boolean | non | true = uniquement les messages marqués importants (réponses aux conversations que vous avez lancées et expéditeurs marqués importants). |
include_spam | boolean | non | Inclure le spam dans les résultats (pour les recherches dans tous les dossiers). |
from | string | non | L’adresse de l’expéditeur contient cette valeur. |
to | string | non | L’adresse du destinataire contient cette valeur. |
unread | boolean | non | true = non lus uniquement, false = lus uniquement. |
after | string | non | Horodatage ISO-8601 ; uniquement les messages créés après celui-ci. (date-time) |
before | string | non | Horodatage ISO-8601 ; uniquement les messages créés avant celui-ci. (date-time) |
query | string | non | Recherche plein texte dans les objets, les corps, les adresses d’expéditeur/destinataire et les noms des pièces jointes. (200 caractères max.) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_emails",
"arguments": {
"direction": "in",
"unread": true,
"limit": 25
}
}get_emailObtenir un e-mail
Récupère un message avec ses en-têtes, son corps html/texte, son statut, les métadonnées du fil et celles des pièces jointes (téléchargez les octets avec download_attachment).
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | Identifiant de l’e-mail (commence par em_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_email",
"arguments": {
"email_id": "em_123"
}
}mark_emailMarquer comme lu, archivé, spam ou important
Met à jour un message : read, archived, category (primary, updates, spam ; courrier reçu uniquement) et important. Signaler un spam ou marquer un message important renseigne SendHQ sur cet expéditeur pour ses futurs e-mails ; passez learn: false pour ne modifier que ce message. Passez au moins un champ.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | Identifiant de l’e-mail (commence par em_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
read | boolean | non | true = lu, false = non lu. |
archived | boolean | non | true = archiver (hors de la Boîte de réception), false = remettre dans la Boîte de réception. |
category | string | non | Déplace un message reçu vers primary, updates ou spam. (valeurs possibles : primary, updates, spam) |
important | boolean | non | Marquer ou démarquer le message comme important. |
learn | boolean | non | false = ne pas mémoriser ce verdict pour l’expéditeur (true par défaut). |
{
"name": "mark_email",
"arguments": {
"email_id": "em_123",
"read": true
}
}delete_emailSupprimer un e-mail
DESTRUCTIVE : supprime définitivement de SendHQ un message conservé et ses pièces jointes stockées. Cela ne rappelle pas un message déjà délivré.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | Identifiant de l’e-mail (commence par em_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "delete_email",
"arguments": {
"email_id": "em_123"
}
}list_email_eventsLister les événements de livraison d’un e-mail
Événements du fournisseur pour un message envoyé : delivery, bounce, complaint, reject, open, click. C’est la preuve qu’un message a été délivré, ou la raison de son échec. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | Identifiant de l’e-mail (commence par em_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_email_events",
"arguments": {
"email_id": "em_123"
}
}get_threadObtenir une conversation
Récupère tous les messages d’une conversation dans l’ordre chronologique (envoyés et reçus), chacun avec les métadonnées de ses pièces jointes.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
thread_id | string | oui | Identifiant du fil (généralement l’identifiant em_… du premier message ; voir threadId sur n’importe quel e-mail). (128 caractères max.) |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | |
limit | integer | non | |
offset | integer | non |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
thread_id | string | oui |
{
"name": "thread_delivery",
"arguments": {
"thread_id": "thr_123"
}
}Libellés et règles de classement automatique
list_labelsLister les libellés
Liste les libellés (dossiers) de l’espace de travail avec leur nombre total de messages et de non-lus, ainsi que leurs règles de classement automatique. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_labels",
"arguments": {}
}get_labelObtenir un libellé
Récupère un libellé avec ses compteurs et ses règles de classement automatique.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
label_id | string | oui | Identifiant du libellé (commence par lbl_) ou nom exact du libellé. (128 caractères max.) |
{
"name": "get_label",
"arguments": {
"label_id": "Billing"
}
}create_labelCréer un libellé
Crée un libellé de type dossier. Définissez skip_inbox: true pour en faire une catégorie appartenant à un agent : envoyez avec labels: [name] et les réponses sont classées sous le libellé et tenues hors de la Boîte de réception. Des règles de classement automatique facultatives classent le nouveau courrier envoyé/reçu (chaque condition d’une règle doit correspondre). Définissez apply_to_existing pour classer aussi le courrier déjà conservé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Nom du libellé, par ex. Billing ou Clients/Acme. Unique par espace de travail (insensible à la casse). (64 caractères max.) |
color | string | non | Couleur hexadécimale, par exemple #1a73e8. Facultatif. |
skip_inbox | boolean | non | Mode catégorie : le courrier reçu qui obtient ce libellé (par une règle, par une réponse à une conversation envoyée avec ce libellé, ou manuellement) est archivé, de sorte qu’il n’apparaît que dans le libellé, pas dans la Boîte de réception. |
rules | object[] | non | Règles de classement automatique facultatives (20 max.). Chacune nécessite au moins l’un des champs inbox_id, from, to, subject. (0–20 éléments) |
rules[].direction | string | non | Uniquement le courrier in (reçu) ou out (envoyé). À omettre pour les deux. (valeurs possibles : in, out) |
rules[].inbox_id | string | non | Uniquement le courrier reçu par cette boîte de réception (inb_…). Classe chaque adresse de réception dans son propre dossier. |
rules[].from | string | non | L’expéditeur contient ce texte (insensible à la casse), par ex. @stripe.com. (200 caractères max.) |
rules[].to | string | non | To/Cc contient ce texte (insensible à la casse). (200 caractères max.) |
rules[].subject | string | non | L’objet contient ce texte (insensible à la casse). (200 caractères max.) |
rules[].skip_inbox | boolean | non | Archive le courrier reçu correspondant pour qu’il n’apparaisse que dans le dossier du libellé, pas dans la Boîte de réception. |
apply_to_existing | boolean | non | Classe aussi le courrier déjà conservé qui correspond aux règles. |
{
"name": "create_label",
"arguments": {
"name": "Agent/Orders",
"skip_inbox": true,
"rules": [
{
"from": "@stripe.com"
}
]
}
}update_labelRenommer un libellé, changer sa couleur ou en faire une catégorie
Renomme un libellé, change sa couleur ou active/désactive le mode catégorie (skip_inbox). Activer le mode catégorie archive le courrier reçu déjà présent dans le libellé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
label_id | string | oui | Identifiant du libellé (commence par lbl_) ou nom exact du libellé. (128 caractères max.) |
name | string | non | Nouveau nom. (64 caractères max.) |
color | string | non | Nouvelle couleur hexadécimale. |
skip_inbox | boolean | non | Mode catégorie : le courrier reçu qui obtient ce libellé (par une règle, par une réponse à une conversation envoyée avec ce libellé, ou manuellement) est archivé, de sorte qu’il n’apparaît que dans le libellé, pas dans la Boîte de réception. |
{
"name": "update_label",
"arguments": {
"label_id": "lbl_123",
"name": "Finance/Billing"
}
}delete_labelSupprimer un libellé
DESTRUCTIVE : supprime un libellé et ses règles. Les e-mails eux-mêmes sont conservés ; ils perdent seulement ce libellé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
label_id | string | oui | Identifiant du libellé (commence par lbl_) ou nom exact du libellé. (128 caractères max.) |
{
"name": "delete_label",
"arguments": {
"label_id": "lbl_123"
}
}create_label_ruleAjouter une règle de classement automatique
Ajoute une règle à un libellé pour que le nouveau courrier correspondant soit classé automatiquement. Chaque condition définie doit correspondre. Utilisez inbox_id pour donner à une adresse de réception son propre dossier ; ajoutez skip_inbox pour tenir ce courrier hors de la Boîte de réception.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
label_id | string | oui | Identifiant du libellé (commence par lbl_) ou nom exact du libellé. (128 caractères max.) |
direction | string | non | Uniquement le courrier in (reçu) ou out (envoyé). À omettre pour les deux. (valeurs possibles : in, out) |
inbox_id | string | non | Uniquement le courrier reçu par cette boîte de réception (inb_…). Classe chaque adresse de réception dans son propre dossier. |
from | string | non | L’expéditeur contient ce texte (insensible à la casse), par ex. @stripe.com. (200 caractères max.) |
to | string | non | To/Cc contient ce texte (insensible à la casse). (200 caractères max.) |
subject | string | non | L’objet contient ce texte (insensible à la casse). (200 caractères max.) |
skip_inbox | boolean | non | Archive le courrier reçu correspondant pour qu’il n’apparaisse que dans le dossier du libellé, pas dans la Boîte de réception. |
apply_to_existing | boolean | non | Classe aussi le courrier déjà conservé qui correspond. |
{
"name": "create_label_rule",
"arguments": {
"label_id": "Billing",
"inbox_id": "inb_123",
"skip_inbox": true
}
}delete_label_ruleSupprimer une règle de classement automatique
DESTRUCTIVE : retire une règle de classement automatique. Le courrier déjà classé conserve son libellé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
label_id | string | oui | Identifiant du libellé (commence par lbl_) ou nom exact du libellé. (128 caractères max.) |
rule_id | string | oui | Identifiant de la règle (commence par lrule_), obtenu via get_label. (128 caractères max.) |
{
"name": "delete_label_rule",
"arguments": {
"label_id": "lbl_123",
"rule_id": "lrule_123"
}
}label_emailAjouter ou retirer des libellés sur un e-mail
Déplace un message entre dossiers : ajoute et/ou retire des libellés par nom ou par identifiant lbl_…. Les noms inconnus dans add sont créés, sauf si create vaut false.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email_id | string | oui | Identifiant de l’e-mail (commence par em_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
add | string[] | non | Libellés à ajouter. (0–10 éléments) |
remove | string[] | non | Libellés à retirer. (0–10 éléments) |
create | boolean | non | Crée les libellés inconnus dans add (true par défaut). |
{
"name": "label_email",
"arguments": {
"email_id": "em_123",
"add": [
"Billing"
],
"remove": [
"Support"
]
}
}Brouillons, pièces jointes et identités d’expéditeur
list_sending_identitiesLister les identités d’expéditeur vérifiées
Adresses et domaines depuis lesquels cet espace de travail peut envoyer dès maintenant (domaines vérifiés, leur From par défaut et adresses des boîtes de réception actives). À appeler avant send_email pour choisir un from valide.
Aucun paramètre.
{
"name": "list_sending_identities",
"arguments": {}
}create_draftCréer un brouillon
Crée un brouillon de rédaction. Les brouillons contiennent les pièces jointes : créez un brouillon, appelez upload_attachment, puis send_email avec draft_id. N’envoie rien.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
from | string | non | Adresse d’expéditeur sur un domaine vérifié (peut rester vide pendant la rédaction). |
to | string[] | non | Destinataires. (0–100 éléments) |
cc | string[] | non | Destinataires en copie. (0–100 éléments) |
bcc | string[] | non | Destinataires en copie cachée. (0–100 éléments) |
subject | string | non | Objet. (998 caractères max.) |
html | string | non | Corps HTML. |
text | string | non | Corps en texte brut. |
reply_to_email_id | string | non | Identifiant de l’e-mail auquel ce brouillon répond. |
thread_id | string | non | Identifiant du fil auquel appartient ce brouillon. |
{
"name": "create_draft",
"arguments": {
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice"
}
}list_draftsLister les brouillons
Liste les brouillons de rédaction, du plus récemment modifié au plus ancien. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_drafts",
"arguments": {}
}get_draftObtenir un brouillon
Récupère un brouillon avec les métadonnées de ses pièces jointes.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
draft_id | string | oui | Identifiant du brouillon (commence par dr_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_draft",
"arguments": {
"draft_id": "dr_123"
}
}update_draftRemplacer le contenu d’un brouillon
Remplace le contenu et les destinataires d’un brouillon. Il s’agit d’un remplacement complet : les champs omis sont effacés ; lisez donc d’abord get_draft et envoyez tous les champs à conserver. Les pièces jointes ne sont pas affectées.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
draft_id | string | oui | Identifiant du brouillon (commence par dr_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
from | string | non | Adresse d’expéditeur sur un domaine vérifié (peut rester vide pendant la rédaction). |
to | string[] | non | Destinataires. (0–100 éléments) |
cc | string[] | non | Destinataires en copie. (0–100 éléments) |
bcc | string[] | non | Destinataires en copie cachée. (0–100 éléments) |
subject | string | non | Objet. (998 caractères max.) |
html | string | non | Corps HTML. |
text | string | non | Corps en texte brut. |
reply_to_email_id | string | non | Identifiant de l’e-mail auquel ce brouillon répond. |
thread_id | string | non | Identifiant du fil auquel appartient ce brouillon. |
{
"name": "update_draft",
"arguments": {
"draft_id": "dr_123",
"from": "hello@example.com",
"to": [
"owner@example.com"
],
"subject": "Invoice (updated)",
"text": "Attached."
}
}delete_draftAbandonner un brouillon
DESTRUCTIVE : abandonne un brouillon et supprime définitivement ses pièces jointes stockées.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
draft_id | string | oui | Identifiant du brouillon (commence par dr_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "delete_draft",
"arguments": {
"draft_id": "dr_123"
}
}upload_attachmentTéléverser une pièce jointe dans un brouillon
Téléverse un fichier dans un brouillon (10 fichiers et 10 MB au total par message au maximum). Fournissez content_base64 ou un file_path local. Les pièces jointes nécessitent une formule payante au moment de l’envoi.
Fournissez au moins l’un des éléments suivants : content_base64, file_path.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
draft_id | string | oui | Identifiant du brouillon (commence par dr_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
filename | string | non | Nom de fichier affiché au destinataire. Par défaut, le nom de base de file_path. (255 caractères max.) |
content_type | string | non | Type MIME, par ex. application/pdf. Par défaut application/octet-stream. |
content_base64 | string | non | Contenu du fichier en base64 standard. |
file_path | string | non | Chemin absolu d’un fichier local lisible par le processus du serveur MCP. |
{
"name": "upload_attachment",
"arguments": {
"draft_id": "dr_123",
"filename": "invoice.pdf",
"content_type": "application/pdf",
"file_path": "/tmp/invoice.pdf"
}
}download_attachmentTélécharger une pièce jointe
Télécharge une pièce jointe privée (envoyée, reçue ou de brouillon). Renvoie le contenu en base64, ou écrit le fichier lorsque save_to_path est défini (refuse d’écraser un fichier sauf si overwrite vaut true).
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
attachment_id | string | oui | Identifiant de la pièce jointe (commence par att_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
save_to_path | string | non | Chemin local absolu facultatif où écrire le fichier au lieu de renvoyer du base64. |
overwrite | boolean | non | Autorise le remplacement d’un fichier existant à save_to_path. false par défaut. |
{
"name": "download_attachment",
"arguments": {
"attachment_id": "att_123",
"save_to_path": "/tmp/invoice.pdf"
}
}delete_attachmentSupprimer une pièce jointe
DESTRUCTIVE : supprime définitivement une pièce jointe stockée (par exemple pour retirer un fichier d’un brouillon avant l’envoi).
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
attachment_id | string | oui | Identifiant de la pièce jointe (commence par att_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "delete_attachment",
"arguments": {
"attachment_id": "att_123"
}
}Modèles hébergés
list_templatesLister les modèles hébergés
Liste les modèles d’e-mails hébergés avec leur état de publication et leur utilisation. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
lifecycle | string | non | active (par défaut), archived ou all. (valeurs possibles : active, archived, all) |
query | string | non | Recherche par nom ou par clé. (120 caractères max.) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_templates",
"arguments": {
"lifecycle": "active"
}
}create_templateCréer un modèle hébergé
Crée un modèle avec un brouillon modifiable, éventuellement à partir d’un modèle de départ (welcome, reset, receipt ou blank). Publiez-le avant d’envoyer par clé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Nom lisible. (120 caractères max.) |
key | string | non | Clé d’envoi stable : lettres minuscules, chiffres, traits d’union ; commence par une lettre (2 à 64 caractères). Dérivée du nom si elle est omise. |
starter | string | non | Contenu de départ. (valeurs possibles : blank, welcome, reset, receipt) |
{
"name": "create_template",
"arguments": {
"name": "Account welcome",
"key": "account-welcome",
"starter": "welcome"
}
}get_templateObtenir un modèle
Récupère le brouillon actuel d’un modèle (avec sa revision), la version publiée active, l’historique des versions et l’utilisation. Accepte un identifiant ou une clé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant (tmpl_…) ou clé du modèle. (128 caractères max.) |
{
"name": "get_template",
"arguments": {
"template_id": "account-welcome"
}
}update_template_draftEnregistrer un brouillon de modèle
Enregistre le brouillon modifiable du modèle avec une concurrence optimiste : passez la revision actuelle obtenue via get_template (409 signifie que quelqu’un d’autre a enregistré avant vous ; relisez et réessayez). Il s’agit d’un remplacement complet du contenu du brouillon : les champs omis sont effacés, envoyez donc tous les champs à conserver. Utilisez des espaces réservés {{variable}}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
revision | integer | oui | Révision actuelle du brouillon, obtenue via get_template. (1–…) |
name | string | non | Nom du modèle. (120 caractères max.) |
subject_template | string | non | Objet avec espaces réservés. (998 caractères max.) |
preheader_template | string | non | Texte d’aperçu. (240 caractères max.) |
html_template | string | non | Corps HTML avec espaces réservés. |
text_template | string | non | Corps en texte brut avec espaces réservés. |
from | string | non | Expéditeur par défaut pour les envois de ce modèle. |
reply_to | string | non | Reply-To par défaut. |
variables | object[] | non | Contrat de variables typées. Chaque élément : {key (minuscules/tirets bas), label, type: text|number|url|boolean, required (true par défaut), fallback, description}. |
variables[].key | string | oui | |
variables[].label | string | non | |
variables[].type | string | non | (valeurs possibles : text, number, url, boolean) |
variables[].required | boolean | non | |
variables[].fallback | any | non | |
variables[].description | string | non | |
sample_data | object | non | Valeurs d’exemple utilisées pour les aperçus et les tests. |
{
"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_draftCréer un nouveau brouillon à partir de la version publiée
Crée un nouveau brouillon modifiable copié à partir de la version publiée actuelle (409 si un brouillon existe déjà ou si rien n’est publié).
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
{
"name": "create_template_draft",
"arguments": {
"template_id": "account-welcome"
}
}render_templateGénérer un aperçu de modèle
Génère le rendu exact produit par le serveur (subject, html, text) pour le brouillon, la version publiée ou une version précise, avec les données fournies. N’envoie rien. Renvoie 422 avec des findings lorsque les données ne respectent pas le contrat de variables.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
version_id | string | non | Identifiant de version facultatif ; par défaut le brouillon, puis la version publiée. |
data | object | non | Valeurs des variables ; par défaut, les données d’exemple de la version. |
{
"name": "render_template",
"arguments": {
"template_id": "account-welcome",
"data": {
"first_name": "Asha"
}
}
}send_template_testEnvoyer un e-mail de test d’un modèle
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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
to | string[] | oui | Destinataires du test. (1–100 éléments) |
from | string | non | Expéditeur sur un domaine vérifié ; par défaut, le From du modèle. |
version_id | string | non | Identifiant de version facultatif. |
data | object | non | Valeurs des variables ; par défaut, les données d’exemple. |
{
"name": "send_template_test",
"arguments": {
"template_id": "account-welcome",
"to": [
"owner@example.com"
]
}
}publish_templatePublier une version de modèle
Publie le brouillon actuel sous forme de version immuable, que send_email utilisera avec template.key. Échoue avec des findings 422 en cas d’erreurs de validation, ou avec 409 si la publication casserait le contrat de variables en vigueur d’un modèle déjà utilisé en production.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
{
"name": "publish_template",
"arguments": {
"template_id": "account-welcome"
}
}archive_templateArchiver un modèle
Bloque les nouveaux envois utilisant ce modèle (l’historique est conservé ; réversible avec restore_template). Toute intégration qui envoie avec cette clé commencera à échouer avec une 404.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
{
"name": "archive_template",
"arguments": {
"template_id": "account-welcome"
}
}restore_templateRestaurer un modèle archivé
Réactive un modèle archivé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | Identifiant ou clé du modèle. (128 caractères max.) |
{
"name": "restore_template",
"arguments": {
"template_id": "account-welcome"
}
}Domaines et DNS
list_domainsLister les domaines
Liste les domaines d’envoi avec leur setup_status global (verified | checking | pending), l’état DNS de chaque enregistrement et l’état de la réception. Peut être lent : les domaines non vérifiés sont revérifiés en direct. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_domains",
"arguments": {}
}get_domainObtenir les détails de configuration d’un domaine
Récupère un domaine avec les enregistrements DNS exacts à publier (type, nom, valeur), l’état en direct de chaque enregistrement vu par deux résolveurs publics, les dns_issues avec leurs correctifs et l’état de la réception.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_domain",
"arguments": {
"domain_id": "dom_123"
}
}add_domainAjouter un domaine d’envoi
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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Nom de domaine nu, par ex. example.com ou mail.example.com. (253 caractères max.) |
default_from | string | non | Adresse d’expéditeur par défaut facultative sur ce domaine. |
{
"name": "add_domain",
"arguments": {
"name": "example.com"
}
}verify_domainVérifier un domaine
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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "verify_domain",
"arguments": {
"domain_id": "dom_123"
}
}delete_domainSupprimer un domaine
DESTRUCTIVE : retire le domaine de l’espace de travail, y compris sa route de réception. Les envois depuis ce domaine échouent immédiatement après. Les enregistrements DNS chez votre fournisseur DNS ne sont pas supprimés.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "delete_domain",
"arguments": {
"domain_id": "dom_123"
}
}get_dns_providerDétecter le fournisseur DNS et les hôtes des enregistrements
Détecte le fournisseur DNS faisant autorité pour le domaine et renvoie l’hôte relatif à saisir chez ce fournisseur pour chaque enregistrement, l’enregistrement DMARC recommandé, des indications pour le MX entrant, et si la configuration en un clic (Domain Connect) est disponible.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_dns_provider",
"arguments": {
"domain_id": "dom_123"
}
}get_domain_connect_linkObtenir un lien de configuration DNS en un clic
Lorsque get_dns_provider signale providers.domainConnect.available, crée une URL de consentement signée. Transmettez-la à l’humain : il l’ouvre et approuve la modification DNS chez son fournisseur. Rien ne change tant qu’il n’a pas approuvé. 409 si ce n’est pas pris en charge.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_domain_connect_link",
"arguments": {
"domain_id": "dom_123"
}
}E-mails entrants
setup_inboundActiver la réception d’e-mails pour un domaine
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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "setup_inbound",
"arguments": {
"domain_id": "dom_123"
}
}verify_inboundVérifier le MX entrant
Revérifie l’enregistrement MX entrant. Le statut passe à ready lorsque les deux résolveurs publics le voient.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "verify_inbound",
"arguments": {
"domain_id": "dom_123"
}
}list_inboxesLister les adresses de réception
Liste les adresses de réception, éventuellement pour un seul domaine. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | non | Filtre facultatif par identifiant de domaine. |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_inboxes",
"arguments": {
"domain_id": "dom_123"
}
}get_inboxObtenir une boîte de réception
Récupère une adresse de réception.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
inbox_id | string | oui | Identifiant de la boîte de réception (commence par inb_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "get_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}create_inboxCréer une adresse de réception
Crée une adresse comme support@<receiving domain> sur un domaine dont l’état de réception est ready (lancez d’abord setup_inbound et verify_inbound). Le courrier reçu apparaît dans list_emails avec la direction in.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain_id | string | oui | Identifiant du domaine (commence par dom_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
local_part | string | oui | Partie avant le @, par ex. support. (64 caractères max.) |
name | string | non | Nom d’affichage facultatif. |
{
"name": "create_inbox",
"arguments": {
"domain_id": "dom_123",
"local_part": "support",
"name": "Support"
}
}update_inboxRenommer, activer ou désactiver une boîte de réception
Renomme une boîte de réception ou définit son statut sur active / disabled.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
inbox_id | string | oui | Identifiant de la boîte de réception (commence par inb_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
name | string | non | Nouveau nom d’affichage. |
status | string | non | Nouveau statut. (valeurs possibles : active, disabled) |
{
"name": "update_inbox",
"arguments": {
"inbox_id": "inb_123",
"status": "disabled"
}
}set_inbox_forwardingTransférer une boîte de réception vers une autre adresse
SENDS REAL EMAIL en cas de transfert vers une personne autre que le propriétaire du compte : définit où le courrier reçu par une boîte de réception est transféré. L’adresse du propriétaire est activée immédiatement ; toute autre adresse reçoit un e-mail de confirmation et le transfert reste pending jusqu’à ce que quelqu’un confirme à cette adresse. Passez forward_to: null pour désactiver le transfert. Les copies transférées partent de l’adresse de la boîte de réception, avec l’expéditeur d’origine en Reply-To.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
inbox_id | string | oui | Identifiant de la boîte de réception (commence par inb_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
forward_to | string,null | oui | Adresse e-mail cible du transfert, ou null pour désactiver le transfert. (254 caractères max.) |
{
"name": "set_inbox_forwarding",
"arguments": {
"inbox_id": "inb_123",
"forward_to": "team@example.net"
}
}delete_inboxSupprimer une boîte de réception
DESTRUCTIVE : supprime une adresse de réception. Le courrier déjà reçu est conservé ; le nouveau courrier envoyé à cette adresse n’y est plus classé.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
inbox_id | string | oui | Identifiant de la boîte de réception (commence par inb_), tel que renvoyé par un outil de liste ou de création. (128 caractères max.) |
{
"name": "delete_inbox",
"arguments": {
"inbox_id": "inb_123"
}
}Délivrabilité, bounces et suppressions
deliverability_statsObtenir les statistiques de livraison sur 30 jours
Totaux sur 30 jours pour l’ensemble de l’espace de travail : sent, delivery, bounce, complaint, reject, open, click et deliveryRate (%).
Aucun paramètre.
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
days | integer | non | (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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
days | integer | non | |
domain | string | non | |
limit | integer | non | |
offset | integer | non |
{
"name": "deliverability_domains",
"arguments": {
"days": 30
}
}deliverability_sendersGet sender delivery rates
Per From address: sent, delivered, hard and soft bounces, complaints, failures, and rates.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
days | integer | non | |
domain | string | non | |
limit | integer | non | |
offset | integer | non |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
subject | string | non | The subject line. |
html | string | non | The HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars) |
text | string | non | 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 | non | 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_reputationLister la réputation des expéditeurs
État de réputation par adresse From exacte : active, throttled (limite quotidienne abaissée) ou paused (les envois renvoient 423), avec le motif et la limite quotidienne. À consulter lorsque les envois échouent avec 423 ou 429. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_sender_reputation",
"arguments": {}
}list_suppressionsLister les suppressions
Liste de suppression de l’espace de travail : destinataires bloqués après un bounce permanent ou une plainte pour spam. Les envois vers eux échouent avec 422. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_suppressions",
"arguments": {}
}remove_suppressionRetirer une suppression pour bounce
DESTRUCTIVE (affaiblit un blocage de sécurité) : retire une suppression pour bounce afin que l’adresse puisse de nouveau recevoir des e-mails. Ne le faites que lorsque l’humain confirme que l’adresse est désormais valide. Les suppressions pour plainte ne peuvent pas être retirées (409).
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email | string | oui | Adresse du destinataire en liste de suppression. (320 caractères max.) |
{
"name": "remove_suppression",
"arguments": {
"email": "fixed-mailbox@example.net"
}
}list_blocked_recipientsLister les destinataires bloqués
Tous les destinataires que SendHQ refusera : bounces, plaintes et désinscriptions marketing par domaine, avec un récapitulatif par type. Lit au maximum les 500 plus récents. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | non | Only members of this list (lst_…). |
status | string | non | 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 | non | Email or name contains this text; * is a wildcard on the email. (max 200 chars) |
tag | string | non | Only contacts with this tag. (max 60 chars) |
source | string | non | How the contact was added. (one of form, api, import) |
after | string | non | Signed up at or after this time. ISO 8601 date or date-time. (max 40 chars) |
before | string | non | Signed up before this time. ISO 8601 date or date-time. (max 40 chars) |
segment_id | string | non | Only contacts matching this saved segment (seg_…). |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email | string | oui | Email address. (max 320 chars) |
name | string | non | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | non | 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[] | non | Tags to attach, e.g. ["VIP"]. Up to 50. (0–50 items) |
list_ids | string[] | non | Lists to add the contact to (lst_…). (0–100 items) |
status | string | non | subscribed (default, requires consent_basis) or unsubscribed. (one of subscribed, unsubscribed) |
consent_basis | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email | string | oui | Email address. (max 320 chars) |
name | string | non | Display name; the first word is {{first_name}}. (max 200 chars) |
fields | object | non | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
tags | string[] | non | Tags to add, e.g. ["VIP"]. Existing tags are kept. (0–50 items) |
timezone | string | non | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
locale | string | non | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
consent_basis | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
contact_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
contact_id | string | oui | Contact ID (starts with ct_) or the contact's email address. (max 320 chars) |
name | string | non | New display name. (max 200 chars) |
fields | object | non | 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[] | non | Replace all of the contact's tags with these. (0–50 items) |
add_tags | string[] | non | Tags to add. (0–50 items) |
remove_tags | string[] | non | Tags to remove. (0–50 items) |
status | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
contact_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
csv | string | oui | The CSV file content, header row first. (max 5242880 chars) |
list_id | string | non | Add every accepted row to this list (lst_…). |
consent_basis | string | oui | 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[] | non | Tags to add to every accepted row, e.g. ["imported-2026-11"]. (0–50 items) |
update_existing | boolean | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
action | string | oui | What to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete) |
contact_ids | string[] | non | Contact IDs (ct_…). Use this or filter. (0–10000 items) |
filter | object | non | Everyone matching these list_contacts filters. Use this or contact_ids. |
filter.list_id | string | non | Members of this list. |
filter.status | string | non | 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 | non | Email or name contains; * is an email wildcard. (max 200 chars) |
filter.tag | string | non | Has this tag. (max 60 chars) |
filter.source | string | non | How the contact was added. (one of form, api, import) |
filter.after | string | non | Signed up at or after. ISO 8601 date or date-time. (max 40 chars) |
filter.before | string | non | Signed up before. ISO 8601 date or date-time. (max 40 chars) |
filter.segment_id | string | non | Matches this segment. |
tags | string[] | non | For tag and untag. (0–50 items) |
list_id | string | non | For add_to_list and remove_from_list (lst_…). |
confirm_count | integer | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
field_key | string | oui | 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 | non | Label shown in the dashboard. Defaults to the key. (max 80 chars) |
type | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
field_key | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_segments",
"arguments": {}
}get_segmentGet a segment
Campaigns: One segment with its conditions and live count.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
segment_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
match | string | non | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | non | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | oui | 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 | non | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | oui | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Segment name. (max 120 chars) |
match | string | non | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | non | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | oui | 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 | non | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | oui | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
segment_id | string | oui | Segment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars) |
name | string | non | Segment name. (max 120 chars) |
match | string | non | all (default): every condition must match. any: at least one. (one of all, any) |
conditions | object[] | non | Up to 20 conditions. Opened and clicked use bot-filtered, estimated engagement. (0–20 items) |
conditions[].field | string | oui | 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 | non | Custom field key when field is field. (max 40 chars) |
conditions[].op | string | oui | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
segment_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | List name, shown on the signup form. (max 200 chars) |
description | string | non | Short description shown on the signup form. (max 500 chars) |
form_enabled | boolean | non | Publish the hosted signup form. |
form_from | string | non | Sender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars) |
redirect_url | string | non | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | non | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | non | Send it. |
welcome.subject | string | non | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | non | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | non | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | non | 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 | non | Publish the site. |
site.slug | string,null | non | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | non | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | non | Short description under the title. (max 300 chars) |
site.accent | string,null | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | oui | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
name | string | non | New name. (max 200 chars) |
description | string | non | New description. (max 500 chars) |
form_enabled | boolean | non | Publish or unpublish the hosted signup form. |
form_from | string | non | Sender of signup confirmation emails, on a verified domain. (max 320 chars) |
redirect_url | string | non | https page to open after a signup is confirmed. (max 500 chars) |
welcome | object | non | Welcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled. |
welcome.enabled | boolean | non | Send it. |
welcome.subject | string | non | Subject; merge tags allowed. (max 300 chars) |
welcome.html | string | non | HTML body; merge tags allowed. (max 500000 chars) |
welcome.markdown | string | non | Markdown body instead of html, rendered with the workspace design. (max 200000 chars) |
site | object | non | 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 | non | Publish the site. |
site.slug | string,null | non | Address after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars) |
site.title | string,null | non | Site title. Defaults to the list name. (max 120 chars) |
site.description | string,null | non | Short description under the title. (max 300 chars) |
site.accent | string,null | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | oui | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_ids | string[] | non | Contact IDs (ct_…). (0–500 items) |
emails | string[] | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
list_id | string | oui | List ID (starts with lst_), as returned by a list or create tool. (max 128 chars) |
contact_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
status | string | non | Only broadcasts with this status. (one of draft, sending, sent, cancelled, failed) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | non | Internal name. Defaults to the subject. (max 200 chars) |
list_id | string | non | The list to send to (lst_…). |
from | string | non | Sender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars) |
reply_to | string | non | Reply-To address. (max 320 chars) |
subject | string | non | Subject line; merge tags allowed. (max 998 chars) |
preview_text | string | non | Inbox preview text shown after the subject. (max 300 chars) |
html | string | non | HTML body; merge tags allowed and escaped. |
text | string | non | Plain-text body; merge tags allowed. |
template | object | non | A published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields. |
template.id | string | non | |
template.key | string | non | |
template.version_id | string | non | |
markdown | string | non | 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 | non | 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 | non | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | non | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | non | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | non | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | non | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | non | 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 | non | Add an open pixel. |
tracking.clicks | boolean | non | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | non | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | non | Publish it. |
web.slug | string,null | non | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
name | string | non | Internal name. (max 200 chars) |
list_id | string | non | The list to send to. |
from | string | non | Sender on a verified domain. (max 320 chars) |
reply_to | string | non | Reply-To address. (max 320 chars) |
subject | string | non | Objet. (998 caractères max.) |
preview_text | string | non | Inbox preview text. (max 300 chars) |
html | string | non | Corps HTML. |
text | string | non | Corps en texte brut. |
template | object,null | non | A published hosted template, or null to remove it. |
markdown | string | non | 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 | non | 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 | non | Which editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks) |
audience | object | non | Who gets it, within the list. Subscribed, non-dormant members only. |
audience.segment_id | string,null | non | Only list members matching this segment (seg_…), or null for the whole list. |
audience.order | string | non | With a limit: signup (default) or engaged (most engaged first). (one of signup, engaged) |
audience.limit | integer,null | non | Send to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000) |
tracking | object | non | 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 | non | Add an open pixel. |
tracking.clicks | boolean | non | Rewrite links to signed SendHQ redirects (the unsubscribe link never is). |
web | object | non | Publish this issue on the list's newsletter site (see create_list site) once it is sent. |
web.enabled | boolean | non | Publish it. |
web.slug | string,null | non | Issue address; defaults to the subject. (max 100 chars) |
web.pinned | boolean | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
idempotency_key | string | non | En-tête Idempotency-Key (200 caractères max.). Ne la réutilisez que pour réessayer exactement cette requête. (200 caractères max.) |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
status | string | non | Only recipients with this outcome. (one of queued, sending, sent, held, skipped, failed) |
activity | string | non | Only recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed) |
query | string | non | Recipient email contains this text. (max 200 chars) |
include | string | non | links adds the links each recipient clicked (implied by activity: clicked). (one of links) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
to | string[] | non | Test recipients (up to 5). (1–5 items) |
contact_id | string | non | Fill merge tags from this contact (ct_…). (max 320 chars) |
remember | boolean | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
scheduled_at | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | Broadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars) |
limit | integer | oui | How many more people at most. (1–10000000) |
idempotency_key | string | non | En-tête Idempotency-Key (200 caractères max.). Ne la réutilisez que pour réessayer exactement cette requête. (200 caractères max.) |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
broadcast_id | string | oui | 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.
Aucun paramètre.
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
postal_address | string | non | Sender's postal address for the footer. Empty string removes it. (max 300 chars) |
design | object | non | Rendering design for Markdown and block content. |
design.accentColor | string,null | non | Hex color like #0a7d4f, or null for the default. |
design.font | string | non | Font family. (one of sans, serif, mono) |
design.align | string | non | Text alignment. (one of left, center) |
cleanup | object | non | List cleanup of readers who stopped opening. |
cleanup.enabled | boolean | non | Turn list cleanup on or off. |
cleanup.afterSends | integer | non | Broadcasts in a row without an open or click (3-50). (3–50) |
cleanup.quietDays | integer | non | Days without engagement (30-730). (30–730) |
cleanup.subject | string,null | non | Subject of the cleanup email; merge tags allowed. (max 200 chars) |
cleanup.body | string,null | non | Body text of the cleanup email. (max 2000 chars) |
cleanup.from | string,null | non | Sender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars) |
test_recipients | string[] | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
days | integer | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
email | string | oui | The contact's email address. (max 320 chars) |
event | string | oui | 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 | non | 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 | non | 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 | non | 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 | non | Changes to the contact, applied with the event. |
contact.name | string | non | Display name. (max 200 chars) |
contact.fields | object | non | Custom fields to merge (string, number, or boolean values), e.g. {"plan": "pro"}. A null value removes a field. |
contact.timezone | string | non | IANA time zone, e.g. Europe/Paris. Automation emails respect sending hours in this zone. (max 64 chars) |
contact.locale | string | non | Language tag, e.g. fr or pt-br. Picks the language version of each automation email. (max 35 chars) |
contact.consent_basis | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
domain | string | non | 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 | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
key | string | oui | Address of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars) |
name | string | oui | Name shown in the dashboard. (max 200 chars) |
audience_label | string | non | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | non | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | non | 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 | oui | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | non | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | non | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | non | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | non | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | non | 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 | non | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | non | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | non | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | non | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | non | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | non | 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 | non | 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 | non | 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 | non | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | non | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | non | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | non | 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 | non | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | non | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | non | Reply-To address. (max 320 chars) |
steps | object[] | non | The emails, in order. position defaults to the place in this list. (0–50 items) |
steps[].position | integer | non | Position of the email in the automation, 1 to 50. (1–50) |
steps[].subject | string | non | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
steps[].preheader | string | non | Inbox preview line. (max 300 chars) |
steps[].content | object | non | 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 | non | HTML body. The unsubscribe footer is added automatically. |
steps[].text | string | non | Corps en texte brut. |
steps[].editor | string | non | 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 | non | 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[] | non | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
name | string | non | Name shown in the dashboard. (max 200 chars) |
audience_label | string | non | Who this is for, in plain words, e.g. Started checkout and left. (max 200 chars) |
goal_label | string | non | What converting means, in a word or two, e.g. paid. (max 80 chars) |
entry | object | non | 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 | oui | Entry type. (one of event, bucket, date_field, manual) |
entry.event | string | non | Event name for an event entry, e.g. checkout_started. |
entry.segment_id | string | non | Segment ID (seg_…) for a bucket entry. (max 128 chars) |
entry.field | string | non | Contact field key for a date_field entry. (max 40 chars) |
entry.reentry | string | non | Whether someone who finished may enter again. (one of never, after_end) |
exit_rules | object | non | 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 | non | Event that counts as converting, e.g. payment_completed. |
exit_rules.no_goal | boolean | non | True when this automation deliberately has no goal. |
exit_rules.stop_events | string[] | non | Events that take a person out, e.g. ["account_closed"]. (0–20 items) |
exit_rules.attribution_days | integer | non | Days before the goal within which an email earns the conversion. Default 14. (1–90) |
settings | object | non | Per-automation settings. Omitted keys keep their value. |
settings.exempt_from_hold | boolean | non | 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 | non | 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 | non | 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 | non | Percent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100) |
settings.stale_days | integer | non | An email more than this many days overdue is skipped instead of sent late. Default 4. (1–365) |
settings.resume_after_days | integer | non | How long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365) |
position | integer | non | 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 | non | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | non | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | oui | Position of the email in the automation, 1 to 50. (1–50) |
template | string | non | 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 | non | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | non | Inbox preview line. (max 300 chars) |
content | object | non | 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 | non | HTML body. The unsubscribe footer is added automatically. |
text | string | non | Corps en texte brut. |
editor | string | non | 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 | non | 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[] | non | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | oui | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | oui | Language tag of the version, e.g. fr or pt-br. (max 35 chars) |
subject | string | non | Subject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars) |
preheader | string | non | Inbox preview line. (max 300 chars) |
content | object | non | 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 | non | HTML body. The unsubscribe footer is added automatically. |
text | string | non | Corps en texte brut. |
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
status | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
position | integer | oui | Position of the email in the automation, 1 to 50. (1–50) |
locale | string | non | 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 | non | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
locale | string | non | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | oui | Email address of an existing contact. (max 320 chars) |
properties | object | non | 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 | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
email | string | oui | Email address of the contact. (max 320 chars) |
reason | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
from | string | non | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | non | Last day of the report as a UTC date (YYYY-MM-DD), inclusive. |
domain | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
from | string | non | First day of the report as a UTC date (YYYY-MM-DD), inclusive. |
to | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
did | string | non | What the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting) |
step | integer | non | Only this email of the automation, by its position. (1–50) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
automation_key | string | oui | Automation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars) |
contact_id | string | oui | 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.
Aucun paramètre.
{
"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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
max_emails | integer | non | Most automation emails one person may get in period_days. Default 2. (1–50) |
period_days | integer | non | The period max_emails applies to, in days. Default 7. (1–90) |
min_gap_hours | integer | non | Least time between two automation emails to one person, in hours. Default 44. (0–720) |
window_start | integer | non | First hour of the day emails may go out, local time (0-23). Default 9. (0–23) |
window_end | integer | non | Hour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24) |
weekdays | integer[] | non | Days emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items) |
default_timezone | string | non | IANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars) |
product_name | string | non | Your product's name, for {{ product_name }}. (max 120 chars) |
sender_name | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
template_id | string | oui | 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 | non | 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 | non | Name shown in the dashboard. Defaults to the template's own name. (max 200 chars) |
from_name | string | non | Sender display name, e.g. Acme. (max 120 chars) |
from_address | string | non | Sender address on a verified workspace domain (see list_sending_identities). (max 320 chars) |
reply_to | string | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
contact | string | non | Only this contact: a contact ID or an email address. (max 320 chars) |
name | string | non | Only this event, e.g. checkout_started. See list_event_names. (max 64 chars) |
from | string | non | Events from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars) |
to | string | non | Events up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars) |
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
connection_id | string | oui | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | What to call it, e.g. Stripe. (max 80 chars) |
kind | string | oui | stripe, dodo, or generic. (one of generic, stripe, dodo) |
consent_basis | string | oui | 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 | non | Put in front of every event name, e.g. stripe_. (max 32 chars) |
enabled | boolean | non | Defaults to true. Pass false to create it switched off. |
mapping | object | non | 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 | non | Where the contact's email address is. (max 120 chars) |
mapping.event | string | non | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | non | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | non | 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 | non | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
connection_id | string | oui | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
name | string | non | A new name. (max 80 chars) |
enabled | boolean | non | true: record what arrives. false: answer 404 and record nothing. |
consent_basis | string | non | 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 | non | Put in front of every event name, e.g. stripe_. (max 32 chars) |
mapping | object | non | 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 | non | Where the contact's email address is. (max 120 chars) |
mapping.event | string | non | Where the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars) |
mapping.event_name | string | non | One fixed event name, instead of event. (max 64 chars) |
mapping.time | string | non | 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 | non | Where a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars) |
mapping.keep | string[] | non | 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.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
connection_id | string | oui | Connection ID, as returned by list_connections (e.g. acn_…). (max 128 chars) |
{
"name": "delete_connection",
"arguments": {
"connection_id": "acn_123"
}
}Compte, utilisation, statistiques et clés
get_accountObtenir le compte, l’utilisation et la facturation
Adresse e-mail du propriétaire du compte, formule/palier d’accès, livraisons par destinataire utilisées sur la période en cours par rapport au quota, domaines utilisés par rapport à la limite, transfert de pièces jointes, résumé de réputation, état de l’abonnement, formules publiées et compteurs de l’espace de travail. À utiliser pour vérifier le quota restant ou le destinataire autorisé pendant l’essai (l’adresse e-mail du compte).
Aucun paramètre.
{
"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.
Aucun paramètre.
{
"name": "get_account_diagnostics",
"arguments": {}
}get_analyticsObtenir les statistiques d’envoi
Statistiques du tableau de bord sur les 7, 30 ou 90 derniers jours : totaux envoyés/reçus/délivrés/bounces/bloqués/ouverts/cliqués/plaintes, chronologie quotidienne, principaux domaines d’envoi et principaux objets.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
days | integer | non | Fenêtre en jours : 7, 30 (par défaut) ou 90. (valeurs possibles : 7, 30, 90) |
{
"name": "get_analytics",
"arguments": {
"days": 30
}
}list_api_keysLister les métadonnées des clés API
Liste les noms des clés API, leurs préfixes non secrets et leurs dates de dernière utilisation. Lecture seule : ce serveur MCP ne peut ni créer, ni faire tourner, ni révoquer de clés ; c’est un humain qui s’en charge dans le tableau de bord. Paginé : le résultat inclut pagination {offset, limit, returned, total?, has_more, next_offset}.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
limit | integer | non | Taille de page. 50 par défaut. (par défaut 50 ; 1–200) |
offset | integer | non | Nombre d’enregistrements à ignorer. Utilisez pagination.next_offset de la page précédente. (par défaut 0 ; 0–…) |
{
"name": "list_api_keys",
"arguments": {}
}get_service_healthVérifier l’état du service SendHQ
Vérifie que l’API SendHQ est opérationnelle et indique quel fournisseur de messagerie est actif. Ne nécessite pas de clé API valide.
Aucun paramètre.
{
"name": "get_service_health",
"arguments": {}
}Inventaire de couverture de l’API
Chaque opération de l’API publique et l’outil qui la couvre. Tout ce qu’un utilisateur peut faire dans le tableau de bord et qui dispose d’une API est couvert ; les exclusions ci-dessous sont délibérées.
| Endpoint | Outil | Remarques |
|---|---|---|
| POST /emails | send_email | Envoyer un e-mail |
| POST /emails/batch | send_batch | Envoyer jusqu’à 100 messages personnalisés |
| GET /emails | list_emails | Lister les e-mails envoyés et reçus |
| GET /emails/:id | get_email | Récupérer un e-mail et ses pièces jointes |
| PATCH /emails/:id | mark_email | Modifier l’état lu, l’archivage, le spam, la catégorie ou l’importance |
| POST /emails/:id/labels | label_email | Ajouter ou retirer des libellés sur un e-mail |
| DELETE /emails/:id | delete_email | Supprimer un e-mail conservé |
| GET /emails/:id/events | list_email_events | Lister les événements de livraison d’un e-mail |
| GET /threads/:id | get_thread | Récupérer une conversation dans l’ordre chronologique |
| GET /labels | list_labels | Lister les libellés avec leur nombre de messages et leurs règles de classement |
| POST /labels | create_label | Créer un libellé, avec des règles de classement automatique en option |
| GET /labels/:id | get_label | Récupérer un libellé par identifiant ou par nom |
| PATCH /labels/:id | update_label | Renommer un libellé, changer sa couleur ou le transformer en catégorie |
| DELETE /labels/:id | delete_label | Supprimer un libellé sans supprimer ses e-mails |
| POST /labels/:id/rules | create_label_rule | Ajouter une règle de classement automatique à un libellé |
| DELETE /labels/:id/rules/:rule_id | delete_label_rule | Supprimer une règle de classement automatique |
| POST /drafts | create_draft | Créer un brouillon de rédaction |
| GET /drafts | list_drafts | Lister les brouillons de rédaction |
| GET /drafts/:id | get_draft | Récupérer un brouillon et ses pièces jointes |
| PUT /drafts/:id | update_draft | Remplacer le contenu d’un brouillon |
| DELETE /drafts/:id | delete_draft | Abandonner un brouillon |
| POST /drafts/:id/attachments | upload_attachment | Téléverser une pièce jointe dans un brouillon |
| GET /attachments/:id | download_attachment | Télécharger une pièce jointe privée |
| DELETE /attachments/:id | delete_attachment | Supprimer une pièce jointe privée |
| GET /sending-identities | list_sending_identities | Lister les identités d’expéditeur vérifiées |
| GET /templates | list_templates | Lister les modèles hébergés |
| POST /templates | create_template | Créer un modèle hébergé |
| GET /templates/:id | get_template | Récupérer les brouillons, les versions publiées et l’utilisation |
| PUT /templates/:id/draft | update_template_draft | Enregistrer automatiquement un brouillon de modèle |
| POST /templates/:id/draft | create_template_draft | Créer un nouveau brouillon à partir de la version publiée |
| POST /templates/:id/render | render_template | Obtenir le rendu exact produit par le serveur |
| POST /templates/:id/test | send_template_test | Envoyer un instantané de test |
| POST /templates/:id/publish | publish_template | Publier une version immuable du modèle |
| POST /templates/:id/archive | archive_template | Archiver un modèle |
| POST /templates/:id/restore | restore_template | Restaurer un modèle archivé |
| POST /domains | add_domain | Ajouter un domaine d’envoi |
| GET /domains | list_domains | Lister les domaines et l’état DNS en cache |
| GET /domains/:id | get_domain | Récupérer les détails de configuration d’un domaine |
| 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 | Vérifier le routage MX entrant |
| DELETE /domains/:id | delete_domain | Supprimer un domaine |
| GET /dns/provider | get_dns_provider | Détecter le fournisseur DNS faisant autorité et les hôtes relatifs des enregistrements |
| GET /dns/domain-connect/connect | get_domain_connect_link | Créer un lien de consentement Domain Connect pour configurer le DNS en un clic |
| POST /inboxes | create_inbox | Créer une adresse de réception |
| GET /inboxes | list_inboxes | Lister les adresses de réception |
| GET /inboxes/:id | get_inbox | Récupérer une adresse de réception |
| PATCH /inboxes/:id | update_inbox | Renommer, activer ou désactiver une boîte de réception |
| PUT /inboxes/:id/forwarding | set_inbox_forwarding | Transférer le courrier reçu par une boîte de réception vers une autre adresse |
| DELETE /inboxes/:id | delete_inbox | Supprimer une boîte de réception en conservant les messages |
| GET /deliverability/stats | deliverability_stats | Récupérer les statistiques de livraison sur 30 jours |
| GET /deliverability/reputation | list_sender_reputation | Lister l’état de réputation par identité d’expéditeur exacte |
| 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 | Lister les suppressions de l’espace de travail |
| DELETE /suppressions/:email | remove_suppression | Retirer une suppression pour bounce éligible |
| GET /blocked-recipients | list_blocked_recipients | Lister les bounces, les plaintes et les désinscriptions |
| GET /webhooks | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | non exposé | 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 | Récupérer le compte, l’utilisation, l’état de facturation et les compteurs de l’espace de travail avec une clé API |
| GET /account/diagnostics | get_account_diagnostics | Diagnose sending and receiving problems in the workspace |
| GET /analytics | get_analytics | Récupérer les statistiques d’envoi du tableau de bord sur 7, 30 ou 90 jours |
| GET /profile | get_account | Équivalent réservé aux sessions de GET /account ; le serveur MCP lit la route par clé API. |
| POST /billing/checkout | non exposé | Les modifications de facturation sont par conception réservées aux sessions et exigent la présence du propriétaire du compte dans le tableau de bord. L’état de facturation peut être lu avec get_account. |
| POST /billing/cancel | non exposé | Les modifications de facturation sont par conception réservées aux sessions et exigent la présence du propriétaire du compte dans le tableau de bord. L’état de facturation peut être lu avec get_account. |
| POST /keys | non exposé | Exclu délibérément : un agent ne doit ni émettre ni détruire d’identifiants. Les clés sont gérées par un humain dans le tableau de bord. |
| GET /keys | list_api_keys | Lister les métadonnées des clés API |
| DELETE /keys/:id | non exposé | Exclu délibérément : un agent ne doit ni émettre ni détruire d’identifiants. Les clés sont gérées par un humain dans le tableau de bord. |
Délibérément non disponible
| Fonctionnalité | Endpoints | Raison |
|---|---|---|
| Créer, faire tourner, révoquer ou supprimer des clés API | POST /keys, DELETE /keys/:id | Exclu délibérément : un agent ne doit ni émettre ni détruire d’identifiants. Les clés sont gérées par un humain dans le tableau de bord. |
| Lancer un paiement ou résilier un abonnement | POST /billing/checkout, POST /billing/cancel | Les modifications de facturation sont par conception réservées aux sessions et exigent la présence du propriétaire du compte dans le tableau de bord. L’état de facturation peut être lu avec get_account. |
| DNS en un clic Cloudflare (OAuth) | GET /api/dns/cloudflare/connect | Nécessite une session de navigateur interactive et un consentement OAuth Cloudflare. Utilisez plutôt les enregistrements de get_domain, les hôtes de get_dns_provider ou get_domain_connect_link. |
| Inscription, connexion, déconnexion, association d’un compte Google | /api/auth/* | Authentification humaine dans le navigateur ; le serveur MCP s’authentifie avec une clé API. |
| Formulaire de contact du support | POST /api/contact | Formulaire public du site marketing destiné aux humains, pas une opération sur l’espace de travail. |
| 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. |
Catalogue lisible par machine : /docs/mcp/tools.json (schémas, annotations, correspondance des endpoints, exclusions). Version Markdown de cette page : /docs/mcp.md. Si la CLI est installée, sendhq commands --format json affiche le même catalogue.