Voor AI-agents

MCP-server van SendHQ

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

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

Wat deze server is

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.

Het is een lokale stdio-server die is ingebouwd in de sendhq CLI-binary. Je MCP-client start sendhq mcp als childproces en communiceert via JSON-RPC over stdin/stdout. Elke toolcall wordt één gedocumenteerd request naar de SendHQ REST API op https://sendhq.cc/api/v1, geauthenticeerd met de API-sleutel van je workspace. De MCP-server heeft dus precies de rechten van die sleutel en niet meer.

  • 142 tools in 10 groups, generated from one catalog that is also published as tools.json.
  • Strikte JSON Schemas: onbekende argumenten, verkeerde types en ontbrekende verplichte velden worden lokaal geweigerd voordat er iets bij SendHQ aankomt.
  • Gestructureerde fouten met een stabiele code, de HTTP-status, een explanation, een concrete remedy en of opnieuw proberen zin heeft.
  • Elke tool die echte e-mail verstuurt of data vernietigt, zegt dat in de eerste woorden van de beschrijving en heeft MCP-veiligheidsannotaties.
  • De modus --read-only verbergt alle tools die verzenden of iets wijzigen.
  • Er wordt niets gelogd. stdout bevat alleen protocolberichten; de API-sleutel en berichtinhoud komen nooit in een log terecht.
Niet het MCP-endpoint voor de documentatie.SendHQ host ook een klein, alleen-lezen MCP-endpoint voor documentatie op https://sendhq.cc/api/mcp (prijzen en docs opzoeken, geen toegang tot je account). De server op deze pagina is de volledige server met toegang tot je account; die draait lokaal of als de gehoste connector hieronder.

Use SendHQ in Claude, ChatGPT and Grok

Geen installatie nodig: SendHQ draait deze server ook als gehoste connector op https://mcp.sendhq.cc/mcp, met dezelfde tools. Je logt in met je SendHQ-account in plaats van een sleutel te plakken.

Claude

  1. Open Settings → Connectors en zoek SendHQ in de directory, of kies Add custom connector en plak https://mcp.sendhq.cc/mcp.
  2. Klik op Connect, log in bij SendHQ, controleer de toegang en klik op Allow.
  3. Vraag Claude om je inbox te controleren, een e-mail vanaf je geverifieerde domein te versturen of een bounce uit te leggen.

ChatGPT

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

Grok

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

Muse by Meta

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

Goedkeuring en verbinding verbreken

  • The request_feature tool sends a feature request to the SendHQ team with your account details, so we can follow up by email.
  • Tools die echte e-mail versturen of data verwijderen, zijn als zodanig gelabeld. Of de assistent je eerst om toestemming vraagt, stel je per tool in de assistent in: kies in Claude voor die tools Needs approval onder Settings → Connectors → SendHQ.
  • De connector krijgt een eigen API-sleutel, genoemd naar de assistent (bijvoorbeeld “Claude (AI connector)”). Verwijder die onder API Keys om de verbinding direct te verbreken.
  • De connector kan geen API-sleutels aanmaken of intrekken en de facturering niet wijzigen. Bijlagen worden als base64 verstuurd en teruggegeven; er is geen toegang tot lokale bestanden.
  • Sending requires an active subscription. There is no free allowance, including mail to the account owner.

Vragen: postmaster@sendhq.cc. Privacy: sendhq.cc/privacy.

Installeren

Installeer de sendhq-binary (Linux, macOS en Windows op x86-64 en arm64). Het installatieprogramma controleert de checksum van de release en zet de binary standaard in ~/.local/bin.

macOS en Linux
curl -fsSL https://downloads.sendhq.cc/install.sh | sh
Windows PowerShell
irm https://downloads.sendhq.cc/install.ps1 | iex
De installatie controleren
sendhq version
SENDHQ_API_KEY=re_your_key sendhq doctor

Maak een API-sleutel aan in het dashboard op https://sendhq.cc/app#/keys. De MCP-server kan geen sleutels aanmaken. Het enige commando dat de server start is:

De stdio-server starten
SENDHQ_API_KEY=re_your_key sendhq mcp

Normaal start je dit nooit handmatig: de MCP-client doet dat. Als je het in een terminal uitvoert, wacht het op JSON-RPC via stdin.

Je client configureren

Claude Code

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

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

Voeg --scope user toe om de server in elk project beschikbaar te maken, of --scope project om hem naar de .mcp.json van het project te schrijven. Verwijs in een gedeelde .mcp.json naar de sleutel uit de omgeving in plaats van hem te committen; Claude Code expandeert ${VAR} in .mcp.json.

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

OpenAI Codex

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

Of via de commandline: codex mcp add sendhq --env SENDHQ_API_KEY=re_your_key -- sendhq mcp.

Claude Desktop

Bewerk claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\) en herstart de app. Desktopapps nemen het PATH van je shell niet over, dus gebruik het absolute pad van de binary (which sendhq).

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

Elke andere MCP-client

Configureer een stdio-server met het commando sendhq, de argumenten ["mcp"] (optioneel "--read-only") en de omgevingsvariabelen hieronder. De server ondersteunt de MCP-protocolversies 2024-11-05, 2025-03-26, 2025-06-18 en 2025-11-25, en implementeert initialize, ping, tools/list en tools/call. Toolresultaten bevatten zowel een JSON-tekstblok als structuredContent.

Ruwe stdio-smoketest (pipe naar sendhq mcp)
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"probe","version":"1"}}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_service_health","arguments":{}}}

Er is geen gehost HTTP-transport voor de server met toegang tot je account. Een remote MCP-endpoint met schrijfrechten zou OAuth per gebruiker vereisen, en dat biedt SendHQ niet; de lokale binary houdt de sleutel op de machine waar hij al staat.

Omgeving en flags

Variabele of flagVerplichtBetekenis
SENDHQ_API_KEYjaAPI-sleutel van de workspace (re_…). Elke tool behalve get_service_health heeft hem nodig. Zonder sleutel start de server wel, maar elke call geeft een gestructureerde auth_error terug die uitlegt hoe je het oplost.
SENDHQ_API_BASE_URLneeBase-URL van de API. Standaard https://sendhq.cc/api/v1. Gebruik dit alleen voor een lokale of staging-omgeving. SENDHQ_BASE_URL wordt geaccepteerd als oudere alias.
SENDHQ_MCP_READ_ONLYnee1, true of yes werkt hetzelfde als --read-only.
--read-onlyneeStelt alleen tools beschikbaar die geen e-mail versturen en niets wijzigen. Verborgen tools worden ook geweigerd als ze bij naam worden aangeroepen.
SENDHQ_PROFILE / --profileneeGebruik een sleutel die sendhq auth login in de keyring van het besturingssysteem heeft opgeslagen, in plaats van SENDHQ_API_KEY. Zijn beide aanwezig, dan heeft de omgevingsvariabele voorrang.

De sleutel wordt alleen als Authorization: Bearer-header naar de geconfigureerde base-URL gestuurd. Hij wordt nooit afgedrukt, gelogd, herhaald in foutmeldingen of opgenomen in toolresultaten.

Veiligheidsmodel voor agents

  • Sends real email. send_email, send_batch, send_template_test, send_broadcast, send_broadcast_test, schedule_broadcast (at the scheduled time), and send_broadcast_to_more deliver mail to real people and consume delivery credits. Their descriptions start with SENDS REAL EMAIL. Call them only when the user explicitly asked for that specific message to be sent, with the recipients, sender, and content confirmed.
  • Destructive. delete_email, delete_draft, delete_attachment, delete_domain, delete_inbox, remove_suppression, the campaign deletes (delete_contact, delete_list, remove_list_contact, delete_broadcast, cancel_broadcast, delete_segment, delete_contact_field), and bulk_update_contacts are marked destructiveHint: true and their descriptions start with DESTRUCTIVE. Confirm with the user first. remove_suppression weakens a safety block and is appropriate only when a human confirms the address works again.
  • Wijzigt de status. Concepten, templates, domeinen en inboxen aanmaken of bijwerken, templates publiceren en verificatie starten wijzigt de workspace, maar verstuurt geen e-mail.
  • Alleen-lezen. Al het andere is readOnlyHint: true en kun je vrij aanroepen.
  • Deze server wijzigt nooit DNS. add_domain geeft records terug die een mens moet publiceren; get_domain_connect_link geeft een toestemmings-URL terug die iemand moet openen en bij de DNS-provider moet goedkeuren.
  • Deze server wijzigt nooit de facturering. get_account leest alleen het abonnement, het gebruik en de status van het 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 (machine in get_broadcast_report).
  • Stap niet over op een ander From-adres om een 423-pauze te omzeilen, en voeg afgemelde ontvangers of ontvangers met een klacht nooit opnieuw toe.

API-sleutels vallen buiten de scope

Er zijn bewust geen tools die API-sleutels aanmaken, wijzigen, roteren, intrekken of verwijderen. Een agent mag geen credentials aanmaken of vernietigen. list_api_keys geeft alleen namen, niet-geheime prefixen en het tijdstip van laatste gebruik terug. Sleutelbeheer blijft in het dashboard, bij een ingelogde mens.

Workflows

1. Eerste verzending

  1. get_service_health bevestigt dat de API bereikbaar is (werkt zonder sleutel).
  2. get_account shows the plan (access.tier) and remaining quota. If there is no active plan, do not send: the call returns subscription_required.
  3. list_sending_identities toont de From-adressen die je kunt gebruiken. Is de lijst leeg, doorloop dan eerst de domeinworkflow.
  4. Bevestig afzender, ontvanger, onderwerp en berichttekst met de gebruiker en roep daarna send_email aan met een idempotency_key.
  5. list_email_events met het teruggegeven id toont delivery, bounce, complaint of reject zodra de provider dat meldt (meestal binnen seconden tot minuten).
Eerste verzending
{
  "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. Domeinverificatie van begin tot eind

  1. add_domain with name: "example.com". The result includes the DNS records (DKIM CNAMEs, domain verification, SPF, recommended DMARC).
  2. get_dns_provider met de domain_id detecteert de gezaghebbende DNS-provider en geeft per record de exacte relatieve host terug die je bij die provider moet invullen.
  3. If providers.domainConnect.available is true, get_domain_connect_link returns a consent URL. Give it to the human; nothing changes until they approve at the provider. Otherwise, give the human the records to publish. Never publish a second SPF record: merge SendHQ's SPF include (include:amazonses.com) into the existing v=spf1 value.
  4. verify_domain rechecks DNS and DKIM verification. Status moves through pending, checking, and propagating to verified. Poll verify_domain or get_domain every 30–60 seconds; DNS can take minutes to hours.
  5. Als status verified is, verschijnen de adressen van het domein in list_sending_identities.

3. Bounces, klachten en suppressies

  1. list_blocked_recipients geeft elk geblokkeerd adres terug met de reden (bounce, complaint, unsubscribe) en een totaaloverzicht.
  2. list_suppressions geeft suppressies door hard bounces en klachten terug; deliverability_stats geeft bezorg-, bounce- en klachtpercentages over 30 dagen; list_sender_reputation laat zien welke From-adressen worden afgeremd of gepauzeerd.
  3. Een verzending met een ontvanger op de suppressielijst mislukt met 422 recipient_suppressed. Verwijder die ontvanger en verstuur opnieuw.
  4. Roep remove_suppression alleen aan als een mens bevestigt dat een mailbox met een bounce nu weer werkt. Suppressies door klachten zijn permanent (409 complaint_suppression_locked).

4. Inkomende e-mail ontvangen

  1. Het domein (vaak een subdomein zoals inbound.example.com) moet geverifieerd zijn.
  2. setup_inbound richt ontvangst in en geeft één MX-record terug. Een mens publiceert het.
  3. verify_inbound totdat status ready is.
  4. create_inbox met domain_id en local_part (bijvoorbeeld support) maakt support@inbound.example.com aan.
  5. Poll list_emails met direction: "in" en unread: true (optioneel inbox_id). Lees een bericht met get_email, de conversatie met get_thread, bijlagen met download_attachment, en markeer het als afgehandeld met mark_email (read: true).
  6. Antwoord in de thread met send_email en reply_to_email_id; SendHQ stelt In-Reply-To, References en de thread in.

5. Webhooks en eventnotificaties

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. Een mislukte bezorging diagnosticeren

  1. Zoek het bericht: list_emails met direction: "out" en to of query, of get_email als je het ID hebt. status: failed betekent dat SendHQ of de provider het bij het aanbieden heeft geweigerd; de fout bij de e-mail legt uit waarom.
  2. list_email_events: bounce (permanent of tijdelijk, met de diagnose van de provider), complaint, reject of delivery. Nog geen events betekent dat de provider nog niets heeft gemeld; wacht en kijk later opnieuw.
  3. If the send call itself failed, read the error code: subscription_required → the owner activates a plan; sender_domain_unverified → finish domain verification; recipient_suppressed → the address hard-bounced or complained before; sender_paused → inspect list_sender_reputation; account_paused → the workspace is paused for review, read the rates; daily_limit_reached → wait until midnight UTC; quota_exhausted → get_account usage.
  4. get_domain controleert of DKIM, SPF en DMARC nog gepubliceerd zijn; deliverability_stats laat zien of het probleem één bericht betreft of een trend is.
  5. Rapporteer wat het bewijs laat zien. Een delivery-event betekent dat de server van de ontvanger het bericht heeft geaccepteerd, niet dat het in de inbox is beland of is gelezen.

7. Een eigen taakbucket (labels)

  1. create_label met name (bijvoorbeeld Agent/Orders) en skip_inbox: true. Daarmee wordt het label een bucket: ontvangen e-mail die het label krijgt, wordt gearchiveerd, zodat hij alleen in het label verschijnt en nooit in de Inbox van de mens.
  2. Verstuur taakmail met send_email (of send_batch) en labels: ["Agent/Orders"]. Antwoorden in die conversatie krijgen automatisch het label en slaan de Inbox over.
  3. Voeg voor e-mail die buiten je conversaties begint een sorteerregel toe: create_label_rule met inbox_id (een apart adres zoals orders@…), from, to of subject. Geef apply_to_existing: true mee om al ontvangen e-mail ook te sorteren.
  4. Werk de bucket af: list_emails met label: "Agent/Orders", direction: "in" en unread: true; lees met get_email of get_thread, antwoord met send_email en reply_to_email_id, en roep mark_email read: true aan als het is afgehandeld.
  5. Verplaats een verdwaald bericht naar de bucket of eruit met label_email (add / remove). Een bucketlabel toevoegen aan een ontvangen bericht archiveert het ook.
  6. Optioneel stuurt set_inbox_forwarding een kopie van alles wat een ontvangend adres binnenkrijgt naar een andere mailbox (het doeladres bevestigt eerst per e-mail).
Verzenden naar een bucket
{
  "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. Bijlagen en templates

Voeg op een betaald abonnement maximaal 10 bestanden toe met send_email attachments (elk bestand heeft content_base64 of een lokaal file_path nodig; filename is standaard de basisnaam van het bestand). Voor gehoste templates: create_template → update_template_draft → render_template voor een voorbeeld met voorbeelddata → send_template_test (verstuurt één echte test) → publish_template, en verstuur daarna met send_email of send_batch via template: {key, data} en precies één to-ontvanger.

9. Send a newsletter

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

10. Run an automation

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

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

11. See what came in, and connect another system

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

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

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

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

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

Resultaten, paginering en fouten

Een geslaagde call geeft het JSON-object van de API terug als structuredContent en als JSON-tekstblok. Elke list_*-tool accepteert limit (1–200, standaard 50) en offset, en voegt een pagination-object toe. Blijf aanroepen met offset: pagination.next_offset zolang has_more true is.

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

Een mislukte call geeft isError: true terug met een gestructureerde fout. Volg remedy in plaats van blind opnieuw te proberen; probeer alleen opnieuw als retryable true is.

Gestructureerde toolfout
{
  "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."
  }
}

Optionele foutvelden: request_id (vermeld die bij support), retry_after_seconds, problems (lijst met schemaschendingen bij invalid_arguments) en idempotent_replayed (zie Idempotentie).

Idempotentie

send_email en send_batch accepteren idempotency_key (maximaal 200 tekens), die wordt meegestuurd als Idempotency-Key-header. Genereer één stabiele sleutel per logisch bericht, bijvoorbeeld invoice-4812-receipt.

  • Een retry moet dezelfde sleutel EN een identieke requestbody gebruiken. Dezelfde sleutel met welke wijziging dan ook (ontvanger, onderwerp, berichttekst, header, templatedata, zelfs argumentwaarden) geeft 409 idempotency_conflict.
  • Dezelfde sleutel, dezelfde body, origineel afgerond: SendHQ geeft het opgeslagen resultaat terug zonder opnieuw te versturen. Zo probeer je het veilig opnieuw na een time-out of network_error.
  • Dezelfde sleutel terwijl het origineel nog loopt: 409 idempotency_in_progress, na korte tijd opnieuw te proberen.
  • Een nieuw logisch bericht heeft een nieuwe sleutel nodig.
  • Opgeslagen fouten worden ook opnieuw afgespeeld. Is de eerste poging mislukt, dan geeft een retry met dezelfde sleutel diezelfde fout terug met idempotent_replayed: true en retryable: false. Controleer met list_emails (direction: out) dat er niets is verstuurd, los de oorzaak op en verstuur daarna met een nieuwe sleutel.
  • De server probeert een POST nooit uit zichzelf opnieuw. Alleen alleen-lezen GET-calls worden automatisch opnieuw geprobeerd (maximaal 3 pogingen bij netwerkfouten, 429 en 5xx).
  • send_email met inline attachments kan geen idempotency_key meekrijgen, omdat het meerdere requests uitvoert. Voor verzendingen met bijlagen die veilig opnieuw kunnen: create_draft → upload_attachment → send_email met draft_id en idempotency_key.
Verzending die veilig opnieuw kan (herhaal exact bij een time-out)
{
  "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"
  }
}

Rate limits en quota

SendHQ publiceert geen vaste limiet voor het aantal requests per seconde op de API. De limieten waar een agent echt tegenaan loopt, zijn gebruikslimieten, die als 429 worden teruggegeven:

  • Maandelijkse afleveringen aan ontvangers per abonnement. Elk To-, Cc- en Bcc-adres telt als één aflevering. Zie get_account → usage.recipientDeliveries vs. usage.emailQuotaMonth.
  • Dagelijkse ontvangers per exact From-adres, bepaald door de reputatiestatus van die afzender (list_sender_reputation → dailyLimit, standaard 2.000 op betaalde abonnementen).
  • Subscription: sending is refused with subscription_required until a paid plan is active. There is no free or trial allowance.
  • Workspace daily ladder on paid plans: 1,000 recipients on day one, then 2,000, 3,000, 5,000, 8,000, 12,000, 18,000, 25,000, 35,000, 45,000, and 50,000. A step is gained after a UTC day that used at least half the cap with healthy 7-day feedback. A high rate demotes once per incident, not every day the rate stays high. See get_account → sendingLimit. Over the cap: daily_limit_reached, not queued, retry after resets_at (midnight UTC), not on a short backoff.
  • Hourly pace: about one tenth of the day's cap each UTC hour (100 on day one). hourly_limit_reached waits until the next UTC hour.
  • New domains: a sending domain less than 30 days old may send at most 500 Gmail recipients a day (gmail_recipient_limit), on any ladder rung. gmail_rate_limited means Gmail returned 4.7.28; wait until resets_at and keep sending to other providers.
  • Bijlagen: maximaal 10 bestanden en 10 MB per bericht; 10 GB aan bijlagenverkeer per maand, gewogen naar ontvangers, op betaalde abonnementen.
  • Per request: To + Cc + Bcc tot 100 adressen; send_batch tot 100 berichten.
  • Reputatie-circuitbreaker: in een rollend venster van 7 dagen zorgen bounces of klachten boven de drempel ervoor dat één From-adres wordt afgeremd of gepauzeerd (423 sender_paused). Het herstelt automatisch zodra de percentages dalen.

quota_exhausted kun je pas opnieuw proberen als de periode opnieuw begint of het abonnement verandert. rate_limited kun je opnieuw proberen na retry_after_seconds; probeer verzendingen opnieuw met dezelfde idempotency_key en een identieke body.

Foutencatalogus

code is stabiel; baseer je logica daarop en niet op message.

codeHTTPOpnieuw?Wat het betekent en wat je moet doen
invalid_arguments—neeDe argumenten voldeden lokaal niet aan het JSON Schema van de tool; er is niets bij SendHQ aangekomen. Corrigeer de velden die in problems staan.
auth_error401neeOntbrekende, ingetrokken of verkeerde API-sleutel. Stel SENDHQ_API_KEY in voor het serverproces; een mens maakt sleutels aan in het dashboard.
subscription_required402neeNo active subscription. Nothing is sent, including to the account owner. The owner chooses a plan. Do not retry until then.
payment_required402neeDe functie vereist een betaald abonnement (bijvoorbeeld bijlagen). Verstuur zonder, of upgrade.
sender_domain_not_owned403neeHet From-domein hoort niet bij deze workspace. Gebruik list_sending_identities of add_domain.
sender_domain_unverified403neeHet From-domein is nog niet geverifieerd. get_domain, ontbrekende records publiceren, verify_domain.
domain_limit_reached403neeDe domeinlimiet van het abonnement is bereikt. Verwijder een ongebruikt domein (na goedkeuring) of upgrade.
marketing_not_enabled403neeDe marketingklasse is niet ingeschakeld voor dit domein of abonnement. Gebruik transactional alleen als het bericht echt transactioneel is.
forbidden403neeHet beleid staat de bewerking niet toe. Pas het request aan.
not_found404neeHet ID hoort niet bij deze workspace. Vraag de resource op om het juiste ID te vinden; herstel gearchiveerde templates eerst.
idempotency_conflict409neeSleutel hergebruikt met een andere body. Verstuur exact het origineel opnieuw, of gebruik een nieuwe sleutel voor een nieuw bericht.
idempotency_in_progress409jaHet oorspronkelijke request loopt nog. Wacht en probeer het dan opnieuw met dezelfde sleutel en body.
revision_conflict409neeHet templateconcept is gewijzigd sinds je het las. get_template, samenvoegen, opnieuw opslaan.
complaint_suppression_locked409neeDe ontvanger heeft een klacht ingediend. Stuur hem nooit meer e-mail.
inbound_not_ready409neeOntvangst van inkomende e-mail is nog niet klaar. setup_inbound, MX publiceren, verify_inbound.
conflict409neeDe resource bestaat al of heeft de verkeerde status. Lees hem en pas aan.
attachments_too_large413neeMeer dan 10 bestanden of 10 MB. Verwijder bijlagen of maak ze kleiner.
recipient_suppressed422neeEen ontvanger gaf eerder een hard bounce of een klacht. Verwijder die; zie list_blocked_recipients.
recipient_unsubscribed422neeEen ontvanger heeft zich afgemeld voor marketingmail. Verwijder die permanent.
validation_failed422neeInhoud geweigerd, bijvoorbeeld templatedata die het variabelencontract schendt. Corrigeer de invoer.
sender_paused423neeDit From-adres is gepauzeerd door de circuitbreaker voor bounces/klachten over 7 dagen. Stop, herstel de lijst en wacht op automatisch herstel.
account_paused423neeWorkspace 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_exhausted429neeMonthly allowance, per-sender daily limit, or attachment transfer. Not the workspace daily ladder. Check get_account; wait for that limit to reset or upgrade.
daily_limit_reached429after resetWorkspace daily ladder. Not a short backoff. Wait until resets_at (midnight UTC). The message was not queued.
hourly_limit_reached429after resetHourly pace (about a tenth of the day's cap). Wait until the next UTC hour. Not a short backoff.
gmail_recipient_limit429after reset500 Gmail recipients a day for a sending domain under 30 days old, on any ladder rung. Wait until midnight UTC. Not queued.
gmail_rate_limited429after resetGmail returned 4.7.28 for this domain. Wait until resets_at. Other providers keep sending.
rate_limited429jaSlow down; wait retry_after_seconds. This is not a daily, hourly, or Gmail cap.
server_error5xxjaTijdelijke fout bij SendHQ of de provider. Wacht met backoff en probeer opnieuw; verzendingen met dezelfde sleutel en body. Is idempotent_replayed true, gebruik dan een nieuwe sleutel nadat je hebt bevestigd dat er niets is verstuurd.
network_error—jaRequest of respons verloren gegaan. Probeer opnieuw; bij verzendingen maakt dezelfde idempotency_key dat veilig.
invalid_request400neeOngeldig request. Lees message en corrigeer het.
tool_error—neeLokale fout binnen de MCP-server (bijvoorbeeld een onleesbaar file_path). Lees message.

Toolreferentie

Elke tool met zijn veiligheidsklasse, het REST-endpoint dat hij aanroept, zijn parameters, de responsstructuur en een voorbeeld van een params-object voor tools/call. De parameters zijn exact: de server weigert alles wat niet vermeld staat.

Emails and threads: send_email, send_batch, list_emails, get_email, mark_email, delete_email, list_email_events, get_thread, email_delivery, thread_delivery
Labels and auto-filing rules: list_labels, get_label, create_label, update_label, delete_label, create_label_rule, delete_label_rule, label_email
Drafts, attachments, and sender identities: list_sending_identities, create_draft, list_drafts, get_draft, update_draft, delete_draft, upload_attachment, download_attachment, delete_attachment
Hosted templates: list_templates, create_template, get_template, update_template_draft, create_template_draft, render_template, send_template_test, publish_template, archive_template, restore_template
Domains and DNS: list_domains, get_domain, add_domain, verify_domain, delete_domain, get_dns_provider, get_domain_connect_link
Inbound email: setup_inbound, verify_inbound, list_inboxes, get_inbox, create_inbox, update_inbox, set_inbox_forwarding, delete_inbox
Deliverability, bounces, and suppressions: deliverability_stats, deliverability_account, deliverability_domains, deliverability_senders, score_email, list_sender_reputation, list_suppressions, remove_suppression, list_blocked_recipients
Campaigns: list_contacts, create_contact, upsert_contact, get_contact, update_contact, delete_contact, import_contacts, list_contact_imports, bulk_update_contacts, list_tags, list_contact_fields, set_contact_field, delete_contact_field, list_segments, get_segment, preview_segment, create_segment, update_segment, delete_segment, list_lists, create_list, get_list, update_list, delete_list, add_list_contacts, remove_list_contact, list_broadcasts, create_broadcast, get_broadcast, update_broadcast, delete_broadcast, send_broadcast, cancel_broadcast, list_broadcast_recipients, check_broadcast, send_broadcast_test, schedule_broadcast, unschedule_broadcast, duplicate_broadcast, send_broadcast_to_more, get_broadcast_report, get_newsletter_settings, update_newsletter_settings, get_campaign_overview, list_uploaded_images
Automations, events, and sending limits: track_event, list_automations, get_automation, create_automation, update_automation, delete_automation, set_automation_step, delete_automation_step, set_automation_step_variant, set_automation_status, send_automation_test_email, send_automation_test, enroll_contact, exit_contact, preview_automation, get_automations_overview, get_automation_report, list_automation_people, get_automation_person, get_sending_limits, update_sending_limits, list_automation_templates, get_automation_template, use_automation_template, list_events, list_event_names, list_connections, get_connection, create_connection, update_connection, delete_connection
Account, usage, analytics, and keys: get_account, get_account_diagnostics, get_analytics, list_api_keys, get_service_health

E-mails en threads

Verstuurt echte e-mailsend_email
POST /emails

Eén e-mail verzenden

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.

Geef minstens één van deze op: html, text, template.

ParameterTypeVerplichtBeschrijving
fromstringjaAfzender, bijv. Acme <hello@example.com>. Het domein moet in deze workspace geverifieerd zijn (zie list_sending_identities). (max. 998 tekens)
tostring[]jaOntvangers. Elk item is een adres, optioneel met een weergavenaam. To+cc+bcc mogen samen maximaal 100 zijn; elke bestemming verbruikt één bezorgcredit. (1–100 items)
ccstring[]neeOntvangers in cc. (0–100 items)
bccstring[]neeOntvangers in bcc. (0–100 items)
subjectstringneeOnderwerpregel. Laat weg bij het versturen van een template. (max. 998 tekens)
textstringneeBerichttekst in plaintext. Geef text, html of template op.
htmlstringneeHTML-berichttekst. SendHQ saneert die en leidt de tekst af als text ontbreekt.
reply_tostringneeReply-To-adres.
headersobjectneeExtra veilige custom headers (stringwaarden), bijv. {"X-Entity-Ref-ID": "123"}. Routeringsheaders zoals From/To/Message-ID worden door SendHQ beheerd.
message_classstringneetransactional (standaard) of marketing. Marketing vereist een abonnement of domein waarop marketing is ingeschakeld en voegt afmeldafhandeling toe. (een van transactional, marketing)
reply_to_email_idstringneeAntwoord binnen een bestaande conversatie: het em_…-ID van het bericht waarop je antwoordt. SendHQ stelt In-Reply-To/References en de thread in.
thread_idstringneeExpliciet thread-ID waaronder het bericht wordt opgeslagen.
draft_idstringneeVerstuur de bijlagen van een opgeslagen concept met dit bericht (dr_…). Het concept wordt na een geslaagde verzending verwijderd.
templateobjectneeVerstuur een gepubliceerde gehoste template in plaats van ruwe html/tekst. Vereist precies één to-ontvanger en geen cc/bcc; de template levert het onderwerp. Geef minstens één van deze op: id, key.
template.idstringneeTemplate-ID (tmpl_…). Geef id of key op.
template.keystringneeTemplatekey, zoals account-welcome. Geef id of key op.
template.version_idstringneeOptioneel ID van een gepubliceerde release (tmplv_…). Standaard de huidige gepubliceerde release.
template.dataobjectneeWaarden voor de getypeerde variabelen van de template.
labelsstring[]neeLabelnamen of lbl_…-ID's waaronder dit bericht wordt opgeslagen. Onbekende namen worden aangemaakt. Antwoorden in de conversatie krijgen dezelfde labels, en een bucketlabel (skip_inbox) houdt die antwoorden uit de Inbox. Max. 10. (0–10 items)
idempotency_keystringneeIdempotency-Key-header (max. 200 tekens). Hergebruik die alleen om exact dit request opnieuw te proberen. (max. 200 tekens)
attachmentsobject[]neeBij te voegen bestanden (max. 10 bestanden, 10 MB in totaal). Elk bestand heeft content_base64 (plus filename) of een lokaal file_path nodig. (0–10 items) Geef minstens één van deze op: content_base64, file_path.
attachments[].filenamestringneeBestandsnaam die de ontvanger ziet. Verplicht bij content_base64; standaard de basisnaam van file_path. (max. 255 tekens)
attachments[].content_typestringneeMIME-type, bijv. application/pdf. Standaard application/octet-stream.
attachments[].content_base64stringneeStandaard base64-inhoud van het bestand.
attachments[].file_pathstringneeAbsoluut pad van een lokaal bestand dat het MCP-serverproces kan lezen.
Retourneert{id: em_…, providerMessageId, threadId, templateId, templateVersionId, isTest}. Acceptatie is geen aflevering: controleer daarna list_email_events.
Voorbeeld van tools/call-params
{
  "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"
  }
}
Verstuurt echte e-mailsend_batch
POST /emails/batch

Een batch individuele e-mails verzenden

SENDS REAL EMAIL. Verstuurt 1–100 onafhankelijke berichten in één request (gebruik dit voor templatepersonalisatie per ontvanger). Elk item heeft dezelfde structuur als send_email (zonder attachments/idempotency_key). Items slagen of mislukken afzonderlijk: HTTP 207 betekent gedeeltelijk succes; controleer elke data[i].ok en data[i].error. Eén idempotency_key geldt voor de hele batchbody.

ParameterTypeVerplichtBeschrijving
emailsobject[]jaTe verzenden berichten. (1–100 items) Geef minstens één van deze op: html, text, template.
idempotency_keystringneeIdempotency-Key voor de hele batch (max. 200 tekens). (max. 200 tekens)
Retourneert{data: [{index, ok, id?, error?: {message, status}}], count, successful, failed}.
Voorbeeld van tools/call-params
{
  "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"
  }
}
Alleen-lezenlist_emails
GET /emails

E-mail opvragen en doorzoeken

Vraagt verzonden (direction: out) en ontvangen (direction: in) e-mail op, nieuwste eerst, met filters. Ontvangen e-mail wordt geclassificeerd: lees de inbox van de mens met direction: in, archived: false, category: primary; triage met important: true; spam is verborgen, tenzij category: spam of include_spam: true. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
directionstringneein voor ontvangen, out voor verzonden. (een van in, out)
statusstringneeStatusfilter, bijv. queued, sent, delivered, bounced, complained, failed.
domainstringneeAlleen berichten voor dit domein, of een kommagescheiden lijst met domeinen (matcht op elk ervan).
inbox_idstringneeAlleen berichten die door deze inbox zijn ontvangen (inb_…).
labelstringneeAlleen berichten met dit label: een label-ID lbl_… of de exacte naam, of een kommagescheiden lijst (matcht op elk ervan). Gebruik list_labels om de mappen te zien.
archivedbooleanneefalse = de Inbox-weergave (ontvangen e-mail die niet is gearchiveerd), true = alleen gearchiveerd. Laat weg voor alle e-mail.
categorystringneeprimary (mensen), updates (nieuwsbrieven, bulk, geautomatiseerd) of spam; of een kommagescheiden lijst. Spam is verborgen, tenzij je erom vraagt.
importantbooleanneetrue = alleen berichten die als belangrijk zijn gemarkeerd (antwoorden op conversaties die jij bent begonnen en afzenders die als belangrijk zijn gemarkeerd).
include_spambooleanneeNeem spam op in de resultaten (voor zoekopdrachten in alle mappen).
fromstringneeAfzenderadres bevat deze waarde.
tostringneeOntvangersadres bevat deze waarde.
unreadbooleanneetrue = alleen ongelezen, false = alleen gelezen.
afterstringneeISO-8601-tijdstempel; alleen berichten die daarna zijn aangemaakt. (date-time)
beforestringneeISO-8601-tijdstempel; alleen berichten die daarvoor zijn aangemaakt. (date-time)
querystringneeVrije-tekstzoekopdracht in onderwerpen, berichtteksten, adressen van afzenders/ontvangers en bestandsnamen van bijlagen. (max. 200 tekens)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [samenvattingen van e-mails], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_emails",
  "arguments": {
    "direction": "in",
    "unread": true,
    "limit": 25
  }
}
Alleen-lezenget_email
GET /emails/:email_id

Eén e-mail ophalen

Haalt één bericht op met headers, html-/tekstbody, status, threadmetadata en metadata van bijlagen (download de bytes met download_attachment).

ParameterTypeVerplichtBeschrijving
email_idstringjaE-mail-ID (begint met em_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
RetourneertE-mailobject: {id, direction, status, from, to, cc, bcc, subject, html, text, threadId, messageId, providerMessageId, readAt, createdAt, attachments: [{id, filename, contentType, sizeBytes, available}]}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Wijzigt statusmark_email
PATCH /emails/:email_id

Markeren als gelezen, gearchiveerd, spam of belangrijk

Werkt één bericht bij: read, archived, category (primary, updates, spam; alleen ontvangen e-mail) en important. Als je spam meldt of iets als belangrijk markeert, leert SendHQ dat over die afzender voor toekomstige e-mail; geef learn: false mee om alleen dit bericht te wijzigen. Geef minstens één veld op.

ParameterTypeVerplichtBeschrijving
email_idstringjaE-mail-ID (begint met em_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
readbooleanneetrue = gelezen, false = ongelezen.
archivedbooleanneetrue = archiveren (de Inbox overslaan), false = terugzetten naar de Inbox.
categorystringneeVerplaats een ontvangen bericht naar primary, updates of spam. (een van primary, updates, spam)
importantbooleanneeMarkeer het bericht als belangrijk of haal die markering weg.
learnbooleanneefalse = dit oordeel niet onthouden voor de afzender (standaard true).
RetourneertHet bijgewerkte e-mailobject.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "mark_email",
  "arguments": {
    "email_id": "em_123",
    "read": true
  }
}
Destructiefdelete_email
DELETE /emails/:email_id

Een e-mail verwijderen

DESTRUCTIVE: verwijdert een bewaard bericht en de opgeslagen bijlagen permanent uit SendHQ. Een bericht dat al is afgeleverd, wordt niet teruggehaald.

ParameterTypeVerplichtBeschrijving
email_idstringjaE-mail-ID (begint met em_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_email",
  "arguments": {
    "email_id": "em_123"
  }
}
Alleen-lezenlist_email_events
GET /emails/:email_id/events

Bezorgevents van een e-mail opvragen

Provider-events voor één verzonden bericht: delivery, bounce, complaint, reject, open, click. Dit is het bewijs of een bericht is afgeleverd of waarom het is mislukt. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
email_idstringjaE-mail-ID (begint met em_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{event_type, recipient, reason, created_at, …}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_email_events",
  "arguments": {
    "email_id": "em_123"
  }
}
Alleen-lezenget_thread
GET /threads/:thread_id

Een conversatie ophalen

Haalt alle berichten in een conversatie op in chronologische volgorde (verzonden en ontvangen), elk met metadata van de bijlagen.

ParameterTypeVerplichtBeschrijving
thread_idstringjaThread-ID (meestal het em_…-ID van het eerste bericht; zie threadId bij elke e-mail). (max. 128 tekens)
Retourneert{id, subject, data: [e-mails]}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_thread",
  "arguments": {
    "thread_id": "em_123"
  }
}
Read-onlyemail_delivery
GET /emails/:email_id/delivery

Get an email delivery timeline

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

ParameterTypeVerplichtBeschrijving
email_idstringja
limitintegernee
offsetintegernee
Returns{emailId, status, timeline, count, limit, offset}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "email_delivery",
  "arguments": {
    "email_id": "em_123"
  }
}
Read-onlythread_delivery
GET /threads/:thread_id/delivery

Get a thread delivery summary

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

ParameterTypeVerplichtBeschrijving
thread_idstringja
Returns{threadId, delivered, bounced, complained, failed, messages}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "thread_delivery",
  "arguments": {
    "thread_id": "thr_123"
  }
}

Labels en automatische sorteerregels

Alleen-lezenlist_labels
GET /labels

Labels opvragen

Vraagt de labels (mappen) van de workspace op met het totale aantal en het aantal ongelezen berichten, plus hun automatische sorteerregels. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{id, name, color, totalCount, unreadCount, rules: [...]}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_labels",
  "arguments": {}
}
Alleen-lezenget_label
GET /labels/:label_id

Een label ophalen

Haalt één label op met aantallen en automatische sorteerregels.

ParameterTypeVerplichtBeschrijving
label_idstringjaLabel-ID (begint met lbl_) of de exacte labelnaam. (max. 128 tekens)
RetourneertLabelobject.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_label",
  "arguments": {
    "label_id": "Billing"
  }
}
Wijzigt statuscreate_label
POST /labels

Een label aanmaken

Maakt een label in mapstijl aan. Zet skip_inbox: true om er een bucket van een agent van te maken: verstuur met labels: [name] en de antwoorden worden in het label opgeslagen en uit de Inbox gehouden. Optionele automatische sorteerregels sorteren nieuwe verzonden/ontvangen e-mail (elke voorwaarde van een regel moet overeenkomen). Zet apply_to_existing om ook bewaarde e-mail te sorteren.

ParameterTypeVerplichtBeschrijving
namestringjaLabelnaam, bijv. Billing of Clients/Acme. Uniek per workspace (hoofdletterongevoelig). (max. 64 tekens)
colorstringneeHexkleur zoals #1a73e8. Optioneel.
skip_inboxbooleanneeBucketmodus: ontvangen e-mail die dit label krijgt (via een regel, via een antwoord op een conversatie die met dit label is verzonden, of handmatig) wordt gearchiveerd, zodat hij alleen in het label verschijnt en niet in de Inbox.
rulesobject[]neeOptionele automatische sorteerregels (max. 20). Elke regel heeft minstens een van inbox_id, from, to, subject nodig. (0–20 items)
rules[].directionstringneeAlleen in (ontvangen) of out (verzonden) e-mail. Laat weg voor beide. (een van in, out)
rules[].inbox_idstringneeAlleen e-mail die door deze inbox is ontvangen (inb_…). Sorteert elk ontvangend adres in een eigen map.
rules[].fromstringneeAfzender bevat deze tekst (hoofdletterongevoelig), bijv. @stripe.com. (max. 200 tekens)
rules[].tostringneeTo/Cc bevat deze tekst (hoofdletterongevoelig). (max. 200 tekens)
rules[].subjectstringneeOnderwerp bevat deze tekst (hoofdletterongevoelig). (max. 200 tekens)
rules[].skip_inboxbooleanneeArchiveer overeenkomende ontvangen e-mail, zodat die alleen in de labelmap verschijnt en niet in de Inbox.
apply_to_existingbooleanneeSorteer ook al bewaarde e-mail die aan de regels voldoet.
RetourneertHet aangemaakte label met regels.
Voorbeeld van tools/call-params
{
  "name": "create_label",
  "arguments": {
    "name": "Agent/Orders",
    "skip_inbox": true,
    "rules": [
      {
        "from": "@stripe.com"
      }
    ]
  }
}
Wijzigt statusupdate_label
PATCH /labels/:label_id

Een label hernoemen, van kleur veranderen of er een bucket van maken

Hernoemt een label, wijzigt de kleur of schakelt de bucketmodus (skip_inbox) in of uit. Als je de bucketmodus inschakelt, wordt ontvangen e-mail die al in het label staat gearchiveerd.

ParameterTypeVerplichtBeschrijving
label_idstringjaLabel-ID (begint met lbl_) of de exacte labelnaam. (max. 128 tekens)
namestringneeNieuwe naam. (max. 64 tekens)
colorstringneeNieuwe hexkleur.
skip_inboxbooleanneeBucketmodus: ontvangen e-mail die dit label krijgt (via een regel, via een antwoord op een conversatie die met dit label is verzonden, of handmatig) wordt gearchiveerd, zodat hij alleen in het label verschijnt en niet in de Inbox.
RetourneertBijgewerkt label.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_label",
  "arguments": {
    "label_id": "lbl_123",
    "name": "Finance/Billing"
  }
}
Destructiefdelete_label
DELETE /labels/:label_id

Een label verwijderen

DESTRUCTIVE: verwijdert een label en de regels ervan. De e-mail zelf blijft bewaard; die verliest alleen dit label.

ParameterTypeVerplichtBeschrijving
label_idstringjaLabel-ID (begint met lbl_) of de exacte labelnaam. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_label",
  "arguments": {
    "label_id": "lbl_123"
  }
}
Wijzigt statuscreate_label_rule
POST /labels/:label_id/rules

Een automatische sorteerregel toevoegen

Voegt een regel aan een label toe, zodat overeenkomende nieuwe e-mail automatisch wordt gesorteerd. Elke voorwaarde die je instelt, moet overeenkomen. Gebruik inbox_id om een ontvangend adres een eigen map te geven; voeg skip_inbox toe om die e-mail uit de Inbox te houden.

ParameterTypeVerplichtBeschrijving
label_idstringjaLabel-ID (begint met lbl_) of de exacte labelnaam. (max. 128 tekens)
directionstringneeAlleen in (ontvangen) of out (verzonden) e-mail. Laat weg voor beide. (een van in, out)
inbox_idstringneeAlleen e-mail die door deze inbox is ontvangen (inb_…). Sorteert elk ontvangend adres in een eigen map.
fromstringneeAfzender bevat deze tekst (hoofdletterongevoelig), bijv. @stripe.com. (max. 200 tekens)
tostringneeTo/Cc bevat deze tekst (hoofdletterongevoelig). (max. 200 tekens)
subjectstringneeOnderwerp bevat deze tekst (hoofdletterongevoelig). (max. 200 tekens)
skip_inboxbooleanneeArchiveer overeenkomende ontvangen e-mail, zodat die alleen in de labelmap verschijnt en niet in de Inbox.
apply_to_existingbooleanneeSorteer ook al bewaarde e-mail die overeenkomt.
Retourneert{id: lrule_…, labelId, direction, inboxId, from, to, subject, skipInbox}.
Voorbeeld van tools/call-params
{
  "name": "create_label_rule",
  "arguments": {
    "label_id": "Billing",
    "inbox_id": "inb_123",
    "skip_inbox": true
  }
}
Destructiefdelete_label_rule
DELETE /labels/:label_id/rules/:rule_id

Een automatische sorteerregel verwijderen

DESTRUCTIVE: verwijdert één automatische sorteerregel. E-mail die al is gesorteerd, houdt zijn label.

ParameterTypeVerplichtBeschrijving
label_idstringjaLabel-ID (begint met lbl_) of de exacte labelnaam. (max. 128 tekens)
rule_idstringjaRegel-ID (begint met lrule_), uit get_label. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_label_rule",
  "arguments": {
    "label_id": "lbl_123",
    "rule_id": "lrule_123"
  }
}
Wijzigt statuslabel_email
POST /emails/:email_id/labels

Labels aan een e-mail toevoegen of ervan verwijderen

Verplaatst een bericht tussen mappen: voeg labels toe en/of verwijder ze op naam of lbl_…-ID. Onbekende namen in add worden aangemaakt, tenzij create false is.

ParameterTypeVerplichtBeschrijving
email_idstringjaE-mail-ID (begint met em_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
addstring[]neeToe te voegen labels. (0–10 items)
removestring[]neeTe verwijderen labels. (0–10 items)
createbooleanneeMaak onbekende labels in add aan (standaard true).
RetourneertDe bijgewerkte e-mail met labels.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "label_email",
  "arguments": {
    "email_id": "em_123",
    "add": [
      "Billing"
    ],
    "remove": [
      "Support"
    ]
  }
}

Concepten, bijlagen en afzenderidentiteiten

Alleen-lezenlist_sending_identities
GET /sending-identities

Geverifieerde afzenderidentiteiten opvragen

Adressen en domeinen waarvandaan deze workspace op dit moment kan versturen (geverifieerde domeinen, hun standaard-From en actieve inboxadressen). Roep dit aan vóór send_email om een geldige from te kiezen.

Geen parameters.

Retourneert{domains: [geverifieerde domeinnamen], addresses: [afzenderadressen], localParts: [...]}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_sending_identities",
  "arguments": {}
}
Wijzigt statuscreate_draft
POST /drafts

Een concept aanmaken

Maakt een concept in de editor aan. Concepten bevatten bijlagen: maak een concept aan, roep upload_attachment aan en daarna send_email met draft_id. Verstuurt niets.

ParameterTypeVerplichtBeschrijving
fromstringneeAfzenderadres op een geverifieerd domein (mag leeg zijn tijdens het opstellen).
tostring[]neeOntvangers. (0–100 items)
ccstring[]neeOntvangers in cc. (0–100 items)
bccstring[]neeOntvangers in bcc. (0–100 items)
subjectstringneeOnderwerpregel. (max. 998 tekens)
htmlstringneeHTML-berichttekst.
textstringneeBerichttekst in plaintext.
reply_to_email_idstringneeE-mail-ID waarop dit concept antwoordt.
thread_idstringneeThread-ID waar dit concept bij hoort.
RetourneertConceptobject {id: dr_…, from, to, cc, bcc, subject, html, text, attachments: []}.
Voorbeeld van tools/call-params
{
  "name": "create_draft",
  "arguments": {
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice"
  }
}
Alleen-lezenlist_drafts
GET /drafts

Concepten opvragen

Vraagt concepten uit de editor op, meest recent bijgewerkt eerst. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [concepten], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_drafts",
  "arguments": {}
}
Alleen-lezenget_draft
GET /drafts/:draft_id

Een concept ophalen

Haalt één concept op met de metadata van de bijlagen.

ParameterTypeVerplichtBeschrijving
draft_idstringjaConcept-ID (begint met dr_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
RetourneertConceptobject met attachments.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Wijzigt statusupdate_draft
PUT /drafts/:draft_id

Inhoud van een concept vervangen

Vervangt de inhoud en ontvangers van een concept. Dit is een volledige vervanging: velden die je weglaat, worden leeggemaakt, dus lees eerst get_draft en stuur elk veld mee dat je wilt behouden. Bijlagen blijven ongewijzigd.

ParameterTypeVerplichtBeschrijving
draft_idstringjaConcept-ID (begint met dr_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
fromstringneeAfzenderadres op een geverifieerd domein (mag leeg zijn tijdens het opstellen).
tostring[]neeOntvangers. (0–100 items)
ccstring[]neeOntvangers in cc. (0–100 items)
bccstring[]neeOntvangers in bcc. (0–100 items)
subjectstringneeOnderwerpregel. (max. 998 tekens)
htmlstringneeHTML-berichttekst.
textstringneeBerichttekst in plaintext.
reply_to_email_idstringneeE-mail-ID waarop dit concept antwoordt.
thread_idstringneeThread-ID waar dit concept bij hoort.
RetourneertBijgewerkt conceptobject.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_draft",
  "arguments": {
    "draft_id": "dr_123",
    "from": "hello@example.com",
    "to": [
      "owner@example.com"
    ],
    "subject": "Invoice (updated)",
    "text": "Attached."
  }
}
Destructiefdelete_draft
DELETE /drafts/:draft_id

Een concept weggooien

DESTRUCTIVE: gooit een concept weg en verwijdert de opgeslagen bijlagen permanent.

ParameterTypeVerplichtBeschrijving
draft_idstringjaConcept-ID (begint met dr_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_draft",
  "arguments": {
    "draft_id": "dr_123"
  }
}
Wijzigt statusupload_attachment
POST /drafts/:draft_id/attachments

Een bijlage uploaden naar een concept

Uploadt één bestand naar een concept (max. 10 bestanden en 10 MB in totaal per bericht). Geef content_base64 of een lokaal file_path op. Voor bijlagen is bij het verzenden een betaald abonnement nodig.

Geef minstens één van deze op: content_base64, file_path.

ParameterTypeVerplichtBeschrijving
draft_idstringjaConcept-ID (begint met dr_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
filenamestringneeBestandsnaam die de ontvanger ziet. Standaard de basisnaam van file_path. (max. 255 tekens)
content_typestringneeMIME-type, bijv. application/pdf. Standaard application/octet-stream.
content_base64stringneeStandaard base64-inhoud van het bestand.
file_pathstringneeAbsoluut pad van een lokaal bestand dat het MCP-serverproces kan lezen.
Retourneert{id: att_…, filename, contentType, sizeBytes, available}.
Voorbeeld van tools/call-params
{
  "name": "upload_attachment",
  "arguments": {
    "draft_id": "dr_123",
    "filename": "invoice.pdf",
    "content_type": "application/pdf",
    "file_path": "/tmp/invoice.pdf"
  }
}
Alleen-lezendownload_attachment
GET /attachments/:attachment_id

Een bijlage downloaden

Downloadt een privébijlage (verzonden, ontvangen of van een concept). Geeft base64-inhoud terug, of schrijft het bestand weg als save_to_path is ingesteld (weigert te overschrijven, tenzij overwrite true is).

ParameterTypeVerplichtBeschrijving
attachment_idstringjaBijlage-ID (begint met att_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
save_to_pathstringneeOptioneel absoluut lokaal pad om het bestand naartoe te schrijven in plaats van base64 terug te geven.
overwritebooleanneeSta toe dat een bestaand bestand op save_to_path wordt vervangen. Standaard false.
Retourneert{attachment_id, filename, content_type, size_bytes, content_base64} of {attachment_id, filename, content_type, size_bytes, saved_to}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "download_attachment",
  "arguments": {
    "attachment_id": "att_123",
    "save_to_path": "/tmp/invoice.pdf"
  }
}
Destructiefdelete_attachment
DELETE /attachments/:attachment_id

Een bijlage verwijderen

DESTRUCTIVE: verwijdert een opgeslagen bijlage permanent (bijvoorbeeld om een bestand uit een concept te halen voordat je verstuurt).

ParameterTypeVerplichtBeschrijving
attachment_idstringjaBijlage-ID (begint met att_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_attachment",
  "arguments": {
    "attachment_id": "att_123"
  }
}

Gehoste templates

Alleen-lezenlist_templates
GET /templates

Gehoste templates opvragen

Vraagt gehoste e-mailtemplates op met publicatiestatus en gebruik. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
lifecyclestringneeactive (standaard), archived of all. (een van active, archived, all)
querystringneeZoeken op naam of key. (max. 120 tekens)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [templates], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_templates",
  "arguments": {
    "lifecycle": "active"
  }
}
Wijzigt statuscreate_template
POST /templates

Een gehoste template aanmaken

Maakt een template met een bewerkbaar concept aan, optioneel op basis van een startsjabloon (welcome, reset, receipt of blank). Publiceer de template voordat je op key verstuurt.

ParameterTypeVerplichtBeschrijving
namestringjaLeesbare naam. (max. 120 tekens)
keystringneeStabiele verzendkey: kleine letters, cijfers en koppeltekens; begint met een letter (2–64 tekens). Wordt afgeleid van de naam als je hem weglaat.
starterstringneeStartinhoud. (een van blank, welcome, reset, receipt)
Retourneert{template, draft, activeVersion, versions, usage}.
Voorbeeld van tools/call-params
{
  "name": "create_template",
  "arguments": {
    "name": "Account welcome",
    "key": "account-welcome",
    "starter": "welcome"
  }
}
Alleen-lezenget_template
GET /templates/:template_id

Een template ophalen

Haalt het huidige concept van een template op (met revision), de actieve gepubliceerde release, de releasegeschiedenis en het gebruik. Accepteert een ID of key.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID (tmpl_…) of key. (max. 128 tekens)
Retourneert{template, draft: {id, revision, subjectTemplate, htmlTemplate, textTemplate, variables, sampleData, …} | null, activeVersion, versions, usage}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Wijzigt statusupdate_template_draft
PUT /templates/:template_id/draft

Een templateconcept opslaan

Slaat het bewerkbare concept van de template op met optimistic concurrency: geef de huidige revision uit get_template mee (409 betekent dat iemand anders eerder heeft opgeslagen; lees opnieuw en probeer het nog eens). Dit vervangt de conceptinhoud volledig: weggelaten velden worden leeggemaakt, dus stuur elk veld mee dat je wilt behouden. Gebruik placeholders als {{variable}}.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
revisionintegerjaHuidige conceptrevisie uit get_template. (1–…)
namestringneeTemplatenaam. (max. 120 tekens)
subject_templatestringneeOnderwerp met placeholders. (max. 998 tekens)
preheader_templatestringneeVoorbeeldtekst. (max. 240 tekens)
html_templatestringneeHTML-berichttekst met placeholders.
text_templatestringneeBerichttekst in plaintext met placeholders.
fromstringneeStandaardafzender voor verzendingen van deze template.
reply_tostringneeStandaard-Reply-To.
variablesobject[]neeGetypeerd variabelencontract. Elk item: {key (kleine letters/underscores), label, type: text|number|url|boolean, required (standaard true), fallback, description}.
variables[].keystringja
variables[].labelstringnee
variables[].typestringnee(een van text, number, url, boolean)
variables[].requiredbooleannee
variables[].fallbackanynee
variables[].descriptionstringnee
sample_dataobjectneeVoorbeeldwaarden voor voorbeelden en tests.
Retourneert{template, draft: {revision: next}, validation: {valid, findings}}.
Voorbeeld van tools/call-params
{
  "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"
    }
  }
}
Wijzigt statuscreate_template_draft
POST /templates/:template_id/draft

Een nieuw concept starten vanuit de gepubliceerde release

Maakt een nieuw bewerkbaar concept aan als kopie van de huidige gepubliceerde release (409 als er al een concept bestaat of niets is gepubliceerd).

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
Retourneert{draft}.
Voorbeeld van tools/call-params
{
  "name": "create_template_draft",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Alleen-lezenrender_template
POST /templates/:template_id/render

Een voorbeeld van een template renderen

Rendert de exacte serveruitvoer (onderwerp, html, tekst) voor het concept, de gepubliceerde release of een specifieke versie met de opgegeven data. Verstuurt niets. Geeft 422 met findings terug als de data het variabelencontract schendt.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
version_idstringneeOptioneel versie-ID; standaard het concept, daarna de gepubliceerde release.
dataobjectneeVariabelewaarden; standaard de voorbeelddata van de versie.
Retourneert{subject, html, text, preheader, versionId, versionNumber, isDraft, findings}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "render_template",
  "arguments": {
    "template_id": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}
Verstuurt echte e-mailsend_template_test
POST /templates/:template_id/test

Een testmail van een template versturen

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.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
tostring[]jaTestontvangers. (1–100 items)
fromstringneeAfzender op een geverifieerd domein; standaard de From van de template.
version_idstringneeOptioneel versie-ID.
dataobjectneeVariabelewaarden; standaard de voorbeelddata.
Retourneert{id: em_…, providerMessageId, threadId, isTest: true}.
Voorbeeld van tools/call-params
{
  "name": "send_template_test",
  "arguments": {
    "template_id": "account-welcome",
    "to": [
      "owner@example.com"
    ]
  }
}
Wijzigt statuspublish_template
POST /templates/:template_id/publish

Een templaterelease publiceren

Publiceert het huidige concept als onveranderlijke release die send_email met template.key zal gebruiken. Mislukt met 422 en findings bij validatiefouten, of met 409 als het het live variabelencontract zou breken van een template die al in productie wordt gebruikt.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
Retourneert{template, published}.
Voorbeeld van tools/call-params
{
  "name": "publish_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Wijzigt statusarchive_template
POST /templates/:template_id/archive

Een template archiveren

Stopt nieuwe verzendingen met deze template (de geschiedenis blijft bewaard; terug te draaien met restore_template). Elke integratie die met deze key verstuurt, begint te falen met 404.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
Retourneert{template}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "archive_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}
Wijzigt statusrestore_template
POST /templates/:template_id/restore

Een gearchiveerde template herstellen

Maakt een gearchiveerde template weer actief.

ParameterTypeVerplichtBeschrijving
template_idstringjaTemplate-ID of key. (max. 128 tekens)
Retourneert{template}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "restore_template",
  "arguments": {
    "template_id": "account-welcome"
  }
}

Domeinen en DNS

Alleen-lezenlist_domains
GET /domains

Domeinen opvragen

Vraagt verzenddomeinen op met een samengevatte setup_status (verified | checking | pending), de DNS-status per record en de status van inkomende e-mail. Kan traag zijn: niet-geverifieerde domeinen worden live opnieuw gecontroleerd. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [domeinen met records], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_domains",
  "arguments": {}
}
Alleen-lezenget_domain
GET /domains/:domain_id

Configuratiegegevens van een domein ophalen

Haalt één domein op met de exacte DNS-records die je moet publiceren (type, naam, waarde), de live status van elk record volgens twee publieke resolvers, dns_issues met oplossingen en de status van inkomende e-mail.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{id, name, status, setup_status, dns_propagating, records: [{type, name, value, verified, dns_state}], dns_issues: [{code, message, …}], inbound_domain, inbound_status}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Wijzigt statusadd_domain
POST /domains

Een verzenddomein toevoegen

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.

ParameterTypeVerplichtBeschrijving
namestringjaKale domeinnaam, bijv. example.com of mail.example.com. (max. 253 tekens)
default_fromstringneeOptioneel standaard afzenderadres op dit domein.
Retourneert{id: dom_…, name, status: pending, records: [...], ses: {configured}}.
Voorbeeld van tools/call-params
{
  "name": "add_domain",
  "arguments": {
    "name": "example.com"
  }
}
Wijzigt statusverify_domain
POST /domains/:domain_id/verify

Een domein verifiëren

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.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{domain, checks: {ses, dkim, dkim_status}, status: verified|pending}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "verify_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Destructiefdelete_domain
DELETE /domains/:domain_id

Een domein verwijderen

DESTRUCTIVE: verwijdert het domein uit de workspace, inclusief de route voor inkomende e-mail. Verzendingen vanaf het domein mislukken daarna direct. DNS-records bij je DNS-provider worden niet verwijderd.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_domain",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Alleen-lezenget_dns_provider
GET /dns/provider

DNS-provider en recordhosts detecteren

Detecteert de gezaghebbende DNS-provider van het domein en geeft per record de relatieve host terug die je bij die provider moet invullen, het aanbevolen DMARC-record, richtlijnen voor de inkomende MX en of configuratie met één klik (Domain Connect) beschikbaar is.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{detectionStatus, detected, zone, nameservers, recordHosts: {recordId: host}, inbound, recommendations, authentication, providers: {domainConnect: {available, providerName}}}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_dns_provider",
  "arguments": {
    "domain_id": "dom_123"
  }
}

Inkomende e-mail

Wijzigt statussetup_inbound
POST /domains/:domain_id/inbound/setup

Inkomende e-mail inschakelen voor een domein

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.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{domain: ontvangend domein, status: dns_pending|ready, record: {type: MX, name, value}}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "setup_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Wijzigt statusverify_inbound
POST /domains/:domain_id/inbound/verify

Inkomende MX verifiëren

Controleert het inkomende MX-record opnieuw. De status wordt ready als beide publieke resolvers het zien.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{domain, status: ready|dns_pending|propagating|checking, record}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "verify_inbound",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Alleen-lezenlist_inboxes
GET /inboxes

Inkomende adressen opvragen

Vraagt ontvangende adressen op, optioneel voor één domein. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
domain_idstringneeOptioneel filter op domein-ID.
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{id, address, name, status, domainId}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_inboxes",
  "arguments": {
    "domain_id": "dom_123"
  }
}
Alleen-lezenget_inbox
GET /inboxes/:inbox_id

Een inbox ophalen

Haalt één inkomend adres op.

ParameterTypeVerplichtBeschrijving
inbox_idstringjaInbox-ID (begint met inb_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
RetourneertInboxobject.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}
Wijzigt statuscreate_inbox
POST /inboxes

Een inkomend adres aanmaken

Maakt een adres zoals support@<receiving domain> aan op een domein waarvan de inkomende status ready is (voer eerst setup_inbound en verify_inbound uit). Ontvangen e-mail verschijnt in list_emails met direction in.

ParameterTypeVerplichtBeschrijving
domain_idstringjaDomein-ID (begint met dom_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
local_partstringjaDeel vóór de @, bijv. support. (max. 64 tekens)
namestringneeOptionele weergavenaam.
Retourneert{id: inb_…, address, name, status: active}.
Voorbeeld van tools/call-params
{
  "name": "create_inbox",
  "arguments": {
    "domain_id": "dom_123",
    "local_part": "support",
    "name": "Support"
  }
}
Wijzigt statusupdate_inbox
PATCH /inboxes/:inbox_id

Een inbox hernoemen, inschakelen of uitschakelen

Hernoemt een inbox of zet de status op active / disabled.

ParameterTypeVerplichtBeschrijving
inbox_idstringjaInbox-ID (begint met inb_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
namestringneeNieuwe weergavenaam.
statusstringneeNieuwe status. (een van active, disabled)
RetourneertBijgewerkte inbox.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_inbox",
  "arguments": {
    "inbox_id": "inb_123",
    "status": "disabled"
  }
}
Verstuurt echte e-mailset_inbox_forwarding
PUT /inboxes/:inbox_id/forwarding

Een inbox doorsturen naar een ander adres

SENDS REAL EMAIL bij doorsturen naar iemand anders dan de accounteigenaar: stelt in waarheen de ontvangen e-mail van een inbox wordt doorgestuurd. Het eigen adres van de eigenaar wordt direct actief; elk ander adres krijgt een bevestigingsmail en doorsturen blijft pending totdat iemand daar bevestigt. Geef forward_to: null mee om doorsturen uit te zetten. Doorgestuurde kopieën komen van het inboxadres met de oorspronkelijke afzender als Reply-To.

ParameterTypeVerplichtBeschrijving
inbox_idstringjaInbox-ID (begint met inb_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
forward_tostring,nulljaE-mailadres waarnaar wordt doorgestuurd, of null om doorsturen uit te zetten. (max. 254 tekens)
RetourneertInbox met forwardTo en forwardStatus (off, pending of active).
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "set_inbox_forwarding",
  "arguments": {
    "inbox_id": "inb_123",
    "forward_to": "team@example.net"
  }
}
Destructiefdelete_inbox
DELETE /inboxes/:inbox_id

Een inbox verwijderen

DESTRUCTIVE: verwijdert een inkomend adres. Al ontvangen e-mail blijft bewaard; nieuwe e-mail aan het adres wordt er niet meer in opgeslagen.

ParameterTypeVerplichtBeschrijving
inbox_idstringjaInbox-ID (begint met inb_), zoals teruggegeven door een list- of create-tool. (max. 128 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_inbox",
  "arguments": {
    "inbox_id": "inb_123"
  }
}

Deliverability, bounces en suppressies

Alleen-lezendeliverability_stats
GET /deliverability/stats

Bezorgstatistieken over 30 dagen ophalen

Totalen over 30 dagen voor de hele workspace: sent, delivery, bounce, complaint, reject, open, click en deliveryRate (%).

Geen parameters.

Retourneert{window: 30d, sent, delivery, bounce, complaint, reject, open, click, deliveryRate}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "deliverability_stats",
  "arguments": {}
}
Read-onlydeliverability_account
GET /deliverability/account

Get account delivery rates

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

ParameterTypeVerplichtBeschrijving
daysintegernee(one of 7, 30, 90)
Returns{days, trend, rolling7d, thresholds, ladder}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "deliverability_account",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_domains
GET /deliverability/domains

Get domain delivery rates

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

ParameterTypeVerplichtBeschrijving
daysintegernee
domainstringnee
limitintegernee
offsetintegernee
Returns{days, data, count, limit, offset}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "deliverability_domains",
  "arguments": {
    "days": 30
  }
}
Read-onlydeliverability_senders
GET /deliverability/senders

Get sender delivery rates

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

ParameterTypeVerplichtBeschrijving
daysintegernee
domainstringnee
limitintegernee
offsetintegernee
Returns{days, data, count, limit, offset}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "deliverability_senders",
  "arguments": {
    "days": 30
  }
}
Read-onlyscore_email
POST /deliverability/score

Score an email's content

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

ParameterTypeVerplichtBeschrijving
subjectstringneeThe subject line.
htmlstringneeThe HTML as written, before SendHQ adds its footer or tracking. (max 2000000 chars)
textstringneeThe plain-text part. Compared with the HTML when both are given; scored on its own when there is no HTML. (max 2000000 chars)
fromstringneeThe sender: an email address or a domain such as example.com. Without it, links to other sites are not judged. (max 320 chars)
Returns{score (0 to 100), deductions: [{id, points, count, suggestion}], warnings: [{id, message}]}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "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>"
  }
}
Alleen-lezenlist_sender_reputation
GET /deliverability/reputation

Afzenderreputatie opvragen

Reputatiestatus per exact From-adres: active, throttled (lagere daglimiet) of paused (verzendingen geven 423), met de reden en de daglimiet. Controleer dit als verzendingen mislukken met 423 of 429. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{sender, status, dailyLimit, reason, cleanSince, warnedAt, pausedAt, evaluatedAt}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_sender_reputation",
  "arguments": {}
}
Alleen-lezenlist_suppressions
GET /suppressions

Suppressies opvragen

Suppressielijst van de workspace: ontvangers die zijn geblokkeerd na een permanente bounce of een spamklacht. Verzendingen naar hen mislukken met 422. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{email, reason, detail, created_at}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_suppressions",
  "arguments": {}
}
Destructiefremove_suppression
DELETE /suppressions/:email

Een bouncesuppressie verwijderen

DESTRUCTIVE (verzwakt een veiligheidsblokkade): verwijdert een bouncesuppressie zodat het adres weer e-mail kan ontvangen. Doe dit alleen als de mens bevestigt dat het adres nu geldig is. Suppressies door klachten kunnen niet worden verwijderd (409).

ParameterTypeVerplichtBeschrijving
emailstringjaAdres van de ontvanger op de suppressielijst. (max. 320 tekens)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "remove_suppression",
  "arguments": {
    "email": "fixed-mailbox@example.net"
  }
}
Alleen-lezenlist_blocked_recipients
GET /blocked-recipients

Geblokkeerde ontvangers opvragen

Elke ontvanger die SendHQ weigert: bounces, klachten en afmeldingen voor marketing per domein, met een overzicht per soort. Leest maximaal de 500 nieuwste. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{email, domain, kind: bounce|complaint|unsubscribe, reason, detail, source, status, created_at}], count, summary: {total, bounce, complaint, unsubscribe}, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_blocked_recipients",
  "arguments": {}
}

Campaigns

Read-onlylist_contacts
GET /contacts

List contacts

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

ParameterTypeVerplichtBeschrijving
list_idstringneeOnly members of this list (lst_…).
statusstringneeOnly 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)
querystringneeEmail or name contains this text; * is a wildcard on the email. (max 200 chars)
tagstringneeOnly contacts with this tag. (max 60 chars)
sourcestringneeHow the contact was added. (one of form, api, import)
afterstringneeSigned up at or after this time. ISO 8601 date or date-time. (max 40 chars)
beforestringneeSigned up before this time. ISO 8601 date or date-time. (max 40 chars)
segment_idstringneeOnly contacts matching this saved segment (seg_…).
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [contacts with tags, engagement, dormant, country], count, total, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_contacts",
  "arguments": {
    "status": "subscribed"
  }
}
Changes statecreate_contact
POST /contacts

Add a contact

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

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

Create or update a contact by email

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

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

Get a contact

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

ParameterTypeVerplichtBeschrijving
contact_idstringjaContact ID (starts with ct_) or the contact's email address. (max 320 chars)
ReturnsThe contact.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateupdate_contact
PATCH /contacts/:contact_id

Update, tag, or unsubscribe a contact

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

ParameterTypeVerplichtBeschrijving
contact_idstringjaContact ID (starts with ct_) or the contact's email address. (max 320 chars)
namestringneeNew display name. (max 200 chars)
fieldsobjectneeCustom fields (string, number, or boolean values), e.g. {"plan": "pro"}. Usable in broadcasts as {{fields.plan}} or {{plan}}. On update, a null value removes the field.
tagsstring[]neeReplace all of the contact's tags with these. (0–50 items)
add_tagsstring[]neeTags to add. (0–50 items)
remove_tagsstring[]neeTags to remove. (0–50 items)
statusstringneeOnly unsubscribed is accepted. (one of unsubscribed)
ReturnsThe updated contact.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_contact",
  "arguments": {
    "contact_id": "ct_123",
    "fields": {
      "plan": "team"
    }
  }
}
Destructivedelete_contact
DELETE /contacts/:contact_id

Delete a contact

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

ParameterTypeVerplichtBeschrijving
contact_idstringjaContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_contact",
  "arguments": {
    "contact_id": "ct_123"
  }
}
Changes stateimport_contacts
POST /contact-imports

Import contacts from CSV

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

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

List contact imports

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [imports], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_contact_imports",
  "arguments": {}
}
Destructivebulk_update_contacts
POST /contacts/bulk

Bulk update contacts

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

ParameterTypeVerplichtBeschrijving
actionstringjaWhat to do. (one of tag, untag, add_to_list, remove_from_list, unsubscribe, delete)
contact_idsstring[]neeContact IDs (ct_…). Use this or filter. (0–10000 items)
filterobjectneeEveryone matching these list_contacts filters. Use this or contact_ids.
filter.list_idstringneeMembers of this list.
filter.statusstringneeOnly 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.querystringneeEmail or name contains; * is an email wildcard. (max 200 chars)
filter.tagstringneeHas this tag. (max 60 chars)
filter.sourcestringneeHow the contact was added. (one of form, api, import)
filter.afterstringneeSigned up at or after. ISO 8601 date or date-time. (max 40 chars)
filter.beforestringneeSigned up before. ISO 8601 date or date-time. (max 40 chars)
filter.segment_idstringneeMatches this segment.
tagsstring[]neeFor tag and untag. (0–50 items)
list_idstringneeFor add_to_list and remove_from_list (lst_…).
confirm_countintegerneeFor delete: the number of contacts that will be deleted, from the 409 response. (0–…)
Returns{ok, action, count}; for an unconfirmed delete, a 409 error whose message gives the count.
AnnotationsdestructiveHint
Voorbeeld van tools/call-params
{
  "name": "bulk_update_contacts",
  "arguments": {
    "action": "tag",
    "tags": [
      "october"
    ],
    "filter": {
      "list_id": "lst_123",
      "status": "subscribed"
    }
  }
}
Read-onlylist_tags
GET /tags

List contact tags

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{tag, count}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_tags",
  "arguments": {}
}
Read-onlylist_contact_fields
GET /contact-fields

List custom contact fields

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{key, label, type, createdAt}], count, types, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_contact_fields",
  "arguments": {}
}
Changes stateset_contact_field
PUT /contact-fields/:field_key

Define a custom contact field

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

ParameterTypeVerplichtBeschrijving
field_keystringjaField 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)
labelstringneeLabel shown in the dashboard. Defaults to the key. (max 80 chars)
typestringneetext (default), number, or date. (one of text, number, date)
Returns{key, label, type, createdAt}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "set_contact_field",
  "arguments": {
    "field_key": "plan",
    "label": "Plan",
    "type": "text"
  }
}
Destructivedelete_contact_field
DELETE /contact-fields/:field_key

Delete a custom field definition

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

ParameterTypeVerplichtBeschrijving
field_keystringjaField 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)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_contact_field",
  "arguments": {
    "field_key": "plan"
  }
}
Read-onlylist_segments
GET /segments

List segments

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{id, name, match, conditions, count}], count, fields, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_segments",
  "arguments": {}
}
Read-onlyget_segment
GET /segments/:segment_id

Get a segment

Campaigns: One segment with its conditions and live count.

ParameterTypeVerplichtBeschrijving
segment_idstringjaSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Returns{id, name, match, conditions, count}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlypreview_segment
POST /segments/preview

Preview segment conditions

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

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

Create a segment

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

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

Update a segment

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

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

Delete a segment

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

ParameterTypeVerplichtBeschrijving
segment_idstringjaSegment ID (starts with seg_), as returned by list_segments or create_segment. (max 128 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_segment",
  "arguments": {
    "segment_id": "seg_123"
  }
}
Read-onlylist_lists
GET /lists

List contact lists

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [lists], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_lists",
  "arguments": {}
}
Changes statecreate_list
POST /lists

Create a list

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

ParameterTypeVerplichtBeschrijving
namestringjaList name, shown on the signup form. (max 200 chars)
descriptionstringneeShort description shown on the signup form. (max 500 chars)
form_enabledbooleanneePublish the hosted signup form.
form_fromstringneeSender of signup confirmation emails, e.g. Acme <news@example.com>, on a verified domain. (max 320 chars)
redirect_urlstringneehttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectneeWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleanneeSend it.
welcome.subjectstringneeSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringneeHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringneeMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectneePublic 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.enabledbooleanneePublish the site.
site.slugstring,nullneeAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullneeSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullneeShort description under the title. (max 300 chars)
site.accentstring,nullneeAccent color, e.g. #0a7d4f.
ReturnsThe list.
Voorbeeld van tools/call-params
{
  "name": "create_list",
  "arguments": {
    "name": "Product updates"
  }
}
Read-onlyget_list
GET /lists/:list_id

Get a list

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

ParameterTypeVerplichtBeschrijving
list_idstringjaList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
ReturnsThe list.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateupdate_list
PATCH /lists/:list_id

Update a list

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

ParameterTypeVerplichtBeschrijving
list_idstringjaList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
namestringneeNew name. (max 200 chars)
descriptionstringneeNew description. (max 500 chars)
form_enabledbooleanneePublish or unpublish the hosted signup form.
form_fromstringneeSender of signup confirmation emails, on a verified domain. (max 320 chars)
redirect_urlstringneehttps page to open after a signup is confirmed. (max 500 chars)
welcomeobjectneeWelcome email sent once, from form_from, when someone confirms a signup. Needs subject and html or markdown when enabled.
welcome.enabledbooleanneeSend it.
welcome.subjectstringneeSubject; merge tags allowed. (max 300 chars)
welcome.htmlstringneeHTML body; merge tags allowed. (max 500000 chars)
welcome.markdownstringneeMarkdown body instead of html, rendered with the workspace design. (max 200000 chars)
siteobjectneePublic 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.enabledbooleanneePublish the site.
site.slugstring,nullneeAddress after /n/ (3-48 characters, a-z, 0-9, -). Defaults to the list name. (max 48 chars)
site.titlestring,nullneeSite title. Defaults to the list name. (max 120 chars)
site.descriptionstring,nullneeShort description under the title. (max 300 chars)
site.accentstring,nullneeAccent color, e.g. #0a7d4f.
ReturnsThe updated list.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_list",
  "arguments": {
    "list_id": "lst_123",
    "form_enabled": false
  }
}
Destructivedelete_list
DELETE /lists/:list_id

Delete a list

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

ParameterTypeVerplichtBeschrijving
list_idstringjaList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_list",
  "arguments": {
    "list_id": "lst_123"
  }
}
Changes stateadd_list_contacts
POST /lists/:list_id/contacts

Add contacts to a list

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

ParameterTypeVerplichtBeschrijving
list_idstringjaList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idsstring[]neeContact IDs (ct_…). (0–500 items)
emailsstring[]neeContact email addresses. (0–500 items)
Returns{listId, added, notFound, list}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "add_list_contacts",
  "arguments": {
    "list_id": "lst_123",
    "emails": [
      "ada@example.net"
    ]
  }
}
Destructiveremove_list_contact
DELETE /lists/:list_id/contacts/:contact_id

Remove a contact from a list

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

ParameterTypeVerplichtBeschrijving
list_idstringjaList ID (starts with lst_), as returned by a list or create tool. (max 128 chars)
contact_idstringjaContact ID (starts with ct_) or the contact's email address. (max 320 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "remove_list_contact",
  "arguments": {
    "list_id": "lst_123",
    "contact_id": "ct_123"
  }
}
Read-onlylist_broadcasts
GET /broadcasts

List broadcasts

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

ParameterTypeVerplichtBeschrijving
statusstringneeOnly broadcasts with this status. (one of draft, sending, sent, cancelled, failed)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [broadcasts], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_broadcasts",
  "arguments": {}
}
Changes statecreate_broadcast
POST /broadcasts

Create a broadcast draft

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

ParameterTypeVerplichtBeschrijving
namestringneeInternal name. Defaults to the subject. (max 200 chars)
list_idstringneeThe list to send to (lst_…).
fromstringneeSender on a verified domain, e.g. Acme <news@example.com>. (max 320 chars)
reply_tostringneeReply-To address. (max 320 chars)
subjectstringneeSubject line; merge tags allowed. (max 998 chars)
preview_textstringneeInbox preview text shown after the subject. (max 300 chars)
htmlstringneeHTML body; merge tags allowed and escaped.
textstringneePlain-text body; merge tags allowed.
templateobjectneeA published hosted template instead of subject/html/text. Template variables are filled from the contact's name, email, and fields.
template.idstringnee
template.keystringnee
template.version_idstringnee
markdownstringneeMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullneeBlock 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.
editorstringneeWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectneeWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullneeOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringneeWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullneeSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectneeOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleanneeAdd an open pixel.
tracking.clicksbooleanneeRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectneePublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleanneePublish it.
web.slugstring,nullneeIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleanneeKeep it at the top of the site.
ReturnsThe draft broadcast.
Voorbeeld van tools/call-params
{
  "name": "create_broadcast",
  "arguments": {
    "list_id": "lst_123",
    "from": "news@example.com",
    "subject": "October update",
    "markdown": "Hi {{first_name | there}}, here's what shipped.",
    "audience": {
      "order": "engaged",
      "limit": 1000
    }
  }
}
Read-onlyget_broadcast
GET /broadcasts/:broadcast_id

Get a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe broadcast.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateupdate_broadcast
PATCH /broadcasts/:broadcast_id

Edit a draft broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
namestringneeInternal name. (max 200 chars)
list_idstringneeThe list to send to.
fromstringneeSender on a verified domain. (max 320 chars)
reply_tostringneeReply-To address. (max 320 chars)
subjectstringneeOnderwerpregel. (max. 998 tekens)
preview_textstringneeInbox preview text. (max 300 chars)
htmlstringneeHTML-berichttekst.
textstringneeBerichttekst in plaintext.
templateobject,nullneeA published hosted template, or null to remove it.
markdownstringneeMarkdown body instead of html: converted to a block document and rendered with the workspace design (get_newsletter_settings). Merge tags allowed. Not combinable with html or content. (max 1000000 chars)
contentobject,nullneeBlock 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.
editorstringneeWhich editor the dashboard opens: html or blocks. Set automatically for markdown and content. (one of html, blocks)
audienceobjectneeWho gets it, within the list. Subscribed, non-dormant members only.
audience.segment_idstring,nullneeOnly list members matching this segment (seg_…), or null for the whole list.
audience.orderstringneeWith a limit: signup (default) or engaged (most engaged first). (one of signup, engaged)
audience.limitinteger,nullneeSend to at most this many people (send_broadcast_to_more sends to more later), or null for everyone. (1–10000000)
trackingobjectneeOpen and click tracking, both on by default. Opens are estimates (bot-filtered pixel loads), never proof that someone read the email.
tracking.opensbooleanneeAdd an open pixel.
tracking.clicksbooleanneeRewrite links to signed SendHQ redirects (the unsubscribe link never is).
webobjectneePublish this issue on the list's newsletter site (see create_list site) once it is sent.
web.enabledbooleanneePublish it.
web.slugstring,nullneeIssue address; defaults to the subject. (max 100 chars)
web.pinnedbooleanneeKeep it at the top of the site.
ReturnsThe updated draft.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "subject": "October product update"
  }
}
Destructivedelete_broadcast
DELETE /broadcasts/:broadcast_id

Delete a draft broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast
POST /broadcasts/:broadcast_id/send

Send a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
idempotency_keystringneeIdempotency-Key-header (max. 200 tekens). Hergebruik die alleen om exact dit request opnieuw te proberen. (max. 200 tekens)
ReturnsThe broadcast with status sending and totals.
Voorbeeld van tools/call-params
{
  "name": "send_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "idempotency_key": "october-update"
  }
}
Destructivecancel_broadcast
POST /broadcasts/:broadcast_id/cancel

Cancel a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe cancelled broadcast with totals.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "cancel_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlylist_broadcast_recipients
GET /broadcasts/:broadcast_id/recipients

List broadcast recipients

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
statusstringneeOnly recipients with this outcome. (one of queued, sending, sent, held, skipped, failed)
activitystringneeOnly recipients who did this. (one of opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed)
querystringneeRecipient email contains this text. (max 200 chars)
includestringneelinks adds the links each recipient clicked (implied by activity: clicked). (one of links)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{contactId, email, status, skipReason, emailId, error, provider, deliveredAt, openedAt, clickedAt, opens, clicks, bouncedAt, complainedAt, unsubscribedAt, links?}], count, totals, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_broadcast_recipients",
  "arguments": {
    "broadcast_id": "bc_123",
    "status": "failed"
  }
}
Read-onlycheck_broadcast
GET /broadcasts/:broadcast_id/checks

Run a broadcast's pre-send checks

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{ready, checks: [{id, level: ok|warn|block, label, detail}], audience: {total, matching}}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "check_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_test
POST /broadcasts/:broadcast_id/test

Send a broadcast test

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
tostring[]neeTest recipients (up to 5). (1–5 items)
contact_idstringneeFill merge tags from this contact (ct_…). (max 320 chars)
rememberbooleanneeSave to as the default test recipients.
Returns{data: [{to, id, status: sent|failed, error?}]}.
Voorbeeld van tools/call-params
{
  "name": "send_broadcast_test",
  "arguments": {
    "broadcast_id": "bc_123",
    "to": [
      "owner@example.com"
    ]
  }
}
Sends real emailschedule_broadcast
POST /broadcasts/:broadcast_id/schedule

Schedule a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
scheduled_atstringjaWhen to send: ISO 8601 date-time with a timezone, at least a minute and at most a year ahead, e.g. 2026-11-10T09:00:00Z. (max 40 chars)
ReturnsThe broadcast with scheduledAt.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "schedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123",
    "scheduled_at": "2026-11-10T09:00:00Z"
  }
}
Changes stateunschedule_broadcast
POST /broadcasts/:broadcast_id/unschedule

Unschedule a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe draft broadcast.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "unschedule_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Changes stateduplicate_broadcast
POST /broadcasts/:broadcast_id/duplicate

Duplicate a broadcast

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
ReturnsThe new draft broadcast.
Voorbeeld van tools/call-params
{
  "name": "duplicate_broadcast",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Sends real emailsend_broadcast_to_more
POST /broadcasts/:broadcast_id/send-more

Send a broadcast to more people

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
limitintegerjaHow many more people at most. (1–10000000)
idempotency_keystringneeIdempotency-Key-header (max. 200 tekens). Hergebruik die alleen om exact dit request opnieuw te proberen. (max. 200 tekens)
Returns{added, broadcast}.
Voorbeeld van tools/call-params
{
  "name": "send_broadcast_to_more",
  "arguments": {
    "broadcast_id": "bc_123",
    "limit": 500,
    "idempotency_key": "october-update-more-1"
  }
}
Read-onlyget_broadcast_report
GET /broadcasts/:broadcast_id/report

Get a broadcast report

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

ParameterTypeVerplichtBeschrijving
broadcast_idstringjaBroadcast ID (starts with bc_), as returned by a list or create tool. (max 128 chars)
Returns{stats: {sent, delivered, opened, clicked, bounced, complained, unsubscribed, opens, clicks, rates}, providers, links, timeline, average, machine, tracking, totals, remaining}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_broadcast_report",
  "arguments": {
    "broadcast_id": "bc_123"
  }
}
Read-onlyget_newsletter_settings
GET /newsletter-settings

Get newsletter settings

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

Geen parameters.

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

Update newsletter settings

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

ParameterTypeVerplichtBeschrijving
postal_addressstringneeSender's postal address for the footer. Empty string removes it. (max 300 chars)
designobjectneeRendering design for Markdown and block content.
design.accentColorstring,nullneeHex color like #0a7d4f, or null for the default.
design.fontstringneeFont family. (one of sans, serif, mono)
design.alignstringneeText alignment. (one of left, center)
cleanupobjectneeList cleanup of readers who stopped opening.
cleanup.enabledbooleanneeTurn list cleanup on or off.
cleanup.afterSendsintegerneeBroadcasts in a row without an open or click (3-50). (3–50)
cleanup.quietDaysintegerneeDays without engagement (30-730). (30–730)
cleanup.subjectstring,nullneeSubject of the cleanup email; merge tags allowed. (max 200 chars)
cleanup.bodystring,nullneeBody text of the cleanup email. (max 2000 chars)
cleanup.fromstring,nullneeSender on a verified domain. Defaults to the last sent broadcast's sender. (max 320 chars)
test_recipientsstring[]neeDefault addresses for send_broadcast_test (up to 5). (0–5 items)
ReturnsThe updated settings.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_newsletter_settings",
  "arguments": {
    "postal_address": "Acme Inc., 1 Main St, Springfield",
    "design": {
      "accentColor": "#0a7d4f"
    }
  }
}
Read-onlyget_campaign_overview
GET /campaigns/overview

Get campaign overview

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

ParameterTypeVerplichtBeschrijving
daysintegerneeWindow in days, 7 to 365. Defaults to 30. (7–365)
Returns{subscribers: {active, dormant, pending, joined, left}, series: [{day, subscribers, joined, left}], recent: [{id, name, subject, status, startedAt, sent, openRate, clickRate}], averages}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_campaign_overview",
  "arguments": {
    "days": 30
  }
}
Read-onlylist_uploaded_images
GET /uploads/images

List uploaded images

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{id, url, width, height, size, filename, createdAt}], pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_uploaded_images",
  "arguments": {}
}

Automations, events, and sending limits

Sends real emailtrack_event
POST /events

Record something a contact did

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

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

List automations

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

ParameterTypeVerplichtBeschrijving
domainstringneeOnly 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)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at} plus steps_count and totals], count, domains: [{domain, count}], pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_automations",
  "arguments": {
    "domain": "example.com"
  }
}
Read-onlyget_automation
GET /automations/:automation_key

Get an automation

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

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

Create an automation

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

ParameterTypeVerplichtBeschrijving
keystringjaAddress of the automation: 1-63 characters of a-z, 0-9, and - (e.g. checkout-recovery). (max 63 chars)
namestringjaName shown in the dashboard. (max 200 chars)
audience_labelstringneeWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringneeWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectneeHow 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.typestringjaEntry type. (one of event, bucket, date_field, manual)
entry.eventstringneeEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringneeSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringneeContact field key for a date_field entry. (max 40 chars)
entry.reentrystringneeWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectneeWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullneeEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleanneeTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]neeEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegerneeDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectneePer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleanneeSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullneeAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullneeStored 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_pctnumberneePercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegerneeAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegerneeHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegerneePriority. 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_namestringneeSender display name, e.g. Acme. (max 120 chars)
from_addressstringneeSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringneeReply-To address. (max 320 chars)
stepsobject[]neeThe emails, in order. position defaults to the place in this list. (0–50 items)
steps[].positionintegerneePosition of the email in the automation, 1 to 50. (1–50)
steps[].subjectstringneeSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
steps[].preheaderstringneeInbox preview line. (max 300 chars)
steps[].contentobjectneeBlock 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[].htmlstringneeHTML body. The unsubscribe footer is added automatically.
steps[].textstringneeBerichttekst in plaintext.
steps[].editorstringneeHow 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_secondsintegerneeWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
steps[].skip_if_emptystring[]neeMerge 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_windowbooleanneeSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
Voorbeeld van tools/call-params
{
  "name": "create_automation",
  "arguments": {
    "key": "checkout-recovery",
    "name": "Checkout recovery",
    "audience_label": "Started checkout and left",
    "goal_label": "paid",
    "from_name": "Acme",
    "from_address": "hello@example.com",
    "entry": {
      "type": "event",
      "event": "checkout_started"
    },
    "exit_rules": {
      "goal_event": "payment_completed"
    },
    "steps": [
      {
        "offset_seconds": 3600,
        "subject": "Still thinking it over, {{ first_name | there }}?",
        "html": "<p>Your cart is waiting.</p>"
      }
    ]
  }
}
Changes stateupdate_automation
PATCH /automations/:automation_key

Edit an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
namestringneeName shown in the dashboard. (max 200 chars)
audience_labelstringneeWho this is for, in plain words, e.g. Started checkout and left. (max 200 chars)
goal_labelstringneeWhat converting means, in a word or two, e.g. paid. (max 80 chars)
entryobjectneeHow 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.typestringjaEntry type. (one of event, bucket, date_field, manual)
entry.eventstringneeEvent name for an event entry, e.g. checkout_started.
entry.segment_idstringneeSegment ID (seg_…) for a bucket entry. (max 128 chars)
entry.fieldstringneeContact field key for a date_field entry. (max 40 chars)
entry.reentrystringneeWhether someone who finished may enter again. (one of never, after_end)
exit_rulesobjectneeWhen people leave. goal_event ends the enrolment as converted and credits the latest email sent within attribution_days before it. Each of stop_events ends it without a conversion. An automation with no goal must say so with no_goal: true. Sent whole: it replaces the current rules.
exit_rules.goal_eventstring,nullneeEvent that counts as converting, e.g. payment_completed.
exit_rules.no_goalbooleanneeTrue when this automation deliberately has no goal.
exit_rules.stop_eventsstring[]neeEvents that take a person out, e.g. ["account_closed"]. (0–20 items)
exit_rules.attribution_daysintegerneeDays before the goal within which an email earns the conversion. Default 14. (1–90)
settingsobjectneePer-automation settings. Omitted keys keep their value.
settings.exempt_from_holdbooleanneeSkip the workspace's per-person limits (max_emails and min_gap_hours) for this automation. The sending hours still apply, and its emails still count toward the limits of other automations.
settings.daily_send_capinteger,nullneeAt most this many emails a day from this automation, counted by the day of the workspace's default_timezone; emails over it wait until the next day. null for no cap. (1–…)
settings.daily_entry_capinteger,nullneeStored 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_pctnumberneePercent of people who enter but are sent nothing, to measure what the emails change (0-100). (0–100)
settings.stale_daysintegerneeAn email more than this many days overdue is skipped instead of sent late. Default 4. (1–365)
settings.resume_after_daysintegerneeHow long a waiting enrolment waits after the automation ahead of it ends. Default 3. (0–365)
positionintegerneePriority. 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_namestringneeSender display name, e.g. Acme. (max 120 chars)
from_addressstringneeSender address on a verified workspace domain (see list_sending_identities). (max 320 chars)
reply_tostringneeReply-To address. (max 320 chars)
ReturnsThe automation with steps (each {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}), enrollments {active, waiting}, and overlap [{key, name, contacts}].
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_automation",
  "arguments": {
    "automation_key": "checkout-recovery",
    "name": "Checkout recovery",
    "settings": {
      "holdout_pct": 10
    }
  }
}
Destructivedelete_automation
DELETE /automations/:automation_key

Delete an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Changes stateset_automation_step
PUT /automations/:automation_key/steps/:position

Create or change an email of an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerjaPosition of the email in the automation, 1 to 50. (1–50)
templatestringneeId 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)
subjectstringneeSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringneeInbox preview line. (max 300 chars)
contentobjectneeBlock 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.
htmlstringneeHTML body. The unsubscribe footer is added automatically.
textstringneeBerichttekst in plaintext.
editorstringneeHow 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_secondsintegerneeWhen the email is due, in seconds after the moment the person entered (3600 = one hour, 86400 = one day). May be negative for emails that lead up to a date. When several emails are due at once, only the latest is sent and the earlier ones are skipped. (-31622400–31622400)
skip_if_emptystring[]neeMerge 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_windowbooleanneeSend as soon as it is due, outside the workspace's sending hours too. The per-person limits still apply.
ReturnsThe email: {id, position, offset_seconds, subject, preheader, editor, content, html, text, skip_if_empty, ignore_send_window, variants}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "set_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 2,
    "offset_seconds": 86400,
    "subject": "Your cart is still here",
    "html": "<p>Pick up where you left off.</p>"
  }
}
Destructivedelete_automation_step
DELETE /automations/:automation_key/steps/:position

Remove an email from an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerjaPosition of the email in the automation, 1 to 50. (1–50)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_automation_step",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 3
  }
}
Changes stateset_automation_step_variant
PUT /automations/:automation_key/steps/:position/variants/:locale

Create or change a language version of an email

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerjaPosition of the email in the automation, 1 to 50. (1–50)
localestringjaLanguage tag of the version, e.g. fr or pt-br. (max 35 chars)
subjectstringneeSubject line. Merge tags such as {{ first_name | there }} are filled per contact. (max 998 chars)
preheaderstringneeInbox preview line. (max 300 chars)
contentobjectneeBlock 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.
htmlstringneeHTML body. The unsubscribe footer is added automatically.
textstringneeBerichttekst in plaintext.
Returns{locale, subject, preheader, content, html, text, updated_at}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "set_automation_step_variant",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1,
    "locale": "fr",
    "subject": "Vous hésitez encore ?",
    "html": "<p>Votre panier vous attend.</p>"
  }
}
Sends real emailset_automation_status
POST /automations/:automation_key/status

Turn an automation on or off

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
statusstringjaon to start sending, off to stop. (one of on, off)
ReturnsThe automation: {id, key, name, domain, audience_label, goal_label, status, entry, exit_rules, position, settings, from_name, from_address, reply_to, switched_on_at, created_at, updated_at}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "set_automation_status",
  "arguments": {
    "automation_key": "checkout-recovery",
    "status": "off"
  }
}
Sends real emailsend_automation_test_email
POST /automations/:automation_key/steps/:position/test

Send one automation email to yourself as a test

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
positionintegerjaPosition of the email in the automation, 1 to 50. (1–50)
localestringneeSend 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)
sampleobjectneeValues 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_runbooleanneeSend nothing; return the email as the test would deliver it.
Returns{to, position, locale, subject, id: em_…, status: sent|held}. With dry_run: {dry_run: true, to, from, position, locale, locales, subject, preheader, html, text, sample: [{key, label, value}]}.
Voorbeeld van tools/call-params
{
  "name": "send_automation_test_email",
  "arguments": {
    "automation_key": "checkout-recovery",
    "position": 1
  }
}
Sends real emailsend_automation_test
POST /automations/:automation_key/test

Send every email of an automation to yourself as tests

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

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

Add a contact to an automation

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

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

Take a contact out of an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
emailstringjaEmail address of the contact. (max 320 chars)
reasonstringneeWhy, for the record (max 200 chars). Defaults to manual. (max 200 chars)
ReturnsThe ended enrolment: {id, automation_key, contact_id, status, source, is_holdout, anchor_at, entered_at, next_due_at, exit_reason, ended_at, converted_at}.
Voorbeeld van tools/call-params
{
  "name": "exit_contact",
  "arguments": {
    "automation_key": "checkout-recovery",
    "email": "ada@example.net",
    "reason": "Asked support to stop"
  }
}
Read-onlypreview_automation
GET /automations/:automation_key/preview

Preview what an automation would send now

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{automation_key, status, evaluated_at, data: [{enrollment_id, contact_id, email, status, next_due_at, outcome, reason, until, step: {position, subject, locale}, behind: {key, name}, superseded}], count, counts, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "preview_automation",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlyget_automations_overview
GET /automations/overview

Get results across all automations

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

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

Get the results of one automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
fromstringneeFirst day of the report as a UTC date (YYYY-MM-DD), inclusive.
tostringneeLast day of the report as a UTC date (YYYY-MM-DD), inclusive.
Returns{automation: {key, name, status, goal_label}, from, to, totals, series: [{day, ...}], steps: [{step_id, position, subject, offset_seconds, archived, sent, delivered, opened, clicked, converted, bounced, complained, unsubscribed, held}]}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_automation_report",
  "arguments": {
    "automation_key": "checkout-recovery"
  }
}
Read-onlylist_automation_people
GET /automations/:automation_key/people

List the people in an automation

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

ParameterTypeVerplichtBeschrijving
automation_keystringjaAutomation key, as returned by list_automations (e.g. checkout-recovery). (max 63 chars)
didstringneeWhat the people did. Defaults to entered. (one of entered, sent, delivered, opened, clicked, converted, bounced, unsubscribed, waiting)
stepintegerneeOnly this email of the automation, by its position. (1–50)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{automation_key, did, step, data: [{contact_id, email, name, contact_status, enrollment_id, enrollment_status, at, latest: {did, at, step_position, reason}}], count, next_cursor, counts, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_automation_people",
  "arguments": {
    "automation_key": "checkout-recovery",
    "did": "clicked"
  }
}
Read-onlyget_automation_person
GET /automations/:automation_key/people/:contact_id

Get one person's history in an automation

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

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

Get automation sending limits

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

Geen parameters.

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

Update automation sending limits

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

ParameterTypeVerplichtBeschrijving
max_emailsintegerneeMost automation emails one person may get in period_days. Default 2. (1–50)
period_daysintegerneeThe period max_emails applies to, in days. Default 7. (1–90)
min_gap_hoursintegerneeLeast time between two automation emails to one person, in hours. Default 44. (0–720)
window_startintegerneeFirst hour of the day emails may go out, local time (0-23). Default 9. (0–23)
window_endintegerneeHour sending stops, local time (1-24); must be later than window_start. Default 18. (1–24)
weekdaysinteger[]neeDays emails may go out: 0 = Sunday to 6 = Saturday. Default [1, 2, 3, 4, 5]. (1–7 items)
default_timezonestringneeIANA time zone used for contacts that have none, e.g. Europe/London. (max 64 chars)
product_namestringneeYour product's name, for {{ product_name }}. (max 120 chars)
sender_namestringneeWho the emails are from, for {{ sender_name }}. (max 120 chars)
ReturnsThe updated limits.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_sending_limits",
  "arguments": {
    "max_emails": 3,
    "min_gap_hours": 24,
    "default_timezone": "Europe/London"
  }
}
Read-onlylist_automation_templates
GET /automation-library

List automation templates

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{version, groups, data: [{id, kind, name, purpose, group, set, subject, preview_text, needs_consent, start: {entry, offset_seconds, goal_event, goal_label, skip_if_empty}, merge_keys, fill_in: [{kind, key, placeholder, label, example}]}], sets: [{id, kind, name, purpose, group, needs_consent, emails: [{template, offset_seconds}], start, merge_keys, fill_in}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_automation_templates",
  "arguments": {}
}
Read-onlyget_automation_template
GET /automation-library/:template_id

Get an automation template

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

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

Create an automation from a template

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

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

List what contacts did

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

ParameterTypeVerplichtBeschrijving
contactstringneeOnly this contact: a contact ID or an email address. (max 320 chars)
namestringneeOnly this event, e.g. checkout_started. See list_event_names. (max 64 chars)
fromstringneeEvents from this UTC date (YYYY-MM-DD) or ISO 8601 date-time on. (max 40 chars)
tostringneeEvents up to this UTC date (the whole day) or ISO 8601 date-time. (max 40 chars)
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{id, contact: {id, email, name}, event, words, occurred_at, received_at, source: {type, label, connection_id}, properties, effects: [{did, automation_key, automation_name}]}], count, next_cursor, enrollments (with contact), pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_events",
  "arguments": {
    "name": "checkout_started",
    "from": "2026-11-01"
  }
}
Read-onlylist_event_names
GET /events/names

List the kinds of event recorded

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{event, words, count}], count, days, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_event_names",
  "arguments": {}
}
Read-onlylist_connections
GET /connections

List connections

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

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Returns{data: [{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery {id, at, result, reason, recorded, events, text, provider_event, email}], count, limit, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_connections",
  "arguments": {}
}
Read-onlyget_connection
GET /connections/:connection_id

Get a connection and its last deliveries

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

ParameterTypeVerplichtBeschrijving
connection_idstringjaConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus last_delivery and deliveries: [{id, at, result, reason, recorded, events, text, provider_event, email}].
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}
Sends real emailcreate_connection
POST /connections

Create a connection

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

ParameterTypeVerplichtBeschrijving
namestringjaWhat to call it, e.g. Stripe. (max 80 chars)
kindstringjastripe, dodo, or generic. (one of generic, stripe, dodo)
consent_basisstringjaHow 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_prefixstringneePut in front of every event name, e.g. stripe_. (max 32 chars)
enabledbooleanneeDefaults to true. Pass false to create it switched off.
mappingobjectneeFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringneeWhere the contact's email address is. (max 120 chars)
mapping.eventstringneeWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringneeOne fixed event name, instead of event. (max 64 chars)
mapping.timestringneeWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringneeWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]neeThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at} plus address (shown once) and last_delivery: null.
Voorbeeld van tools/call-params
{
  "name": "create_connection",
  "arguments": {
    "name": "Stripe",
    "kind": "stripe",
    "consent_basis": "Bought a plan on acme.com and accepted product emails"
  }
}
Sends real emailupdate_connection
PATCH /connections/:connection_id

Change a connection or switch it on or off

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

ParameterTypeVerplichtBeschrijving
connection_idstringjaConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
namestringneeA new name. (max 80 chars)
enabledbooleanneetrue: record what arrives. false: answer 404 and record nothing.
consent_basisstringneeHow 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_prefixstringneePut in front of every event name, e.g. stripe_. (max 32 chars)
mappingobjectneeFor a generic connection: dotted paths into the payload it posts, such as customer.email. email is required, and either event or event_name.
mapping.emailstringneeWhere the contact's email address is. (max 120 chars)
mapping.eventstringneeWhere the payload names what happened. Order Placed becomes the event order_placed. (max 120 chars)
mapping.event_namestringneeOne fixed event name, instead of event. (max 64 chars)
mapping.timestringneeWhere the time it happened is (ISO 8601, or Unix seconds or milliseconds). Defaults to the time of arrival. (max 120 chars)
mapping.idstringneeWhere a unique ID of the message is, so a retried delivery is recorded once. (max 120 chars)
mapping.keepstring[]neeThe fields to keep as event properties. Defaults to the top-level text, number, and boolean fields. (0–50 items)
Returns{id, name, kind, enabled, event_prefix, consent_basis, has_signing_secret, address_ending, mapping (generic only), created_at, updated_at}.
AnnotatiesidempotentHint
Voorbeeld van tools/call-params
{
  "name": "update_connection",
  "arguments": {
    "connection_id": "acn_123",
    "enabled": false
  }
}
Destructivedelete_connection
DELETE /connections/:connection_id

Delete a connection

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

ParameterTypeVerplichtBeschrijving
connection_idstringjaConnection ID, as returned by list_connections (e.g. acn_…). (max 128 chars)
Retourneert{ok: true}.
AnnotatiesdestructiveHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "delete_connection",
  "arguments": {
    "connection_id": "acn_123"
  }
}

Account, gebruik, analytics en sleutels

Alleen-lezenget_account
GET /account

Account, gebruik en facturering ophalen

E-mailadres van de accounteigenaar, abonnement/toegangsniveau, gebruikte afleveringen aan ontvangers in de huidige periode vs. quotum, gebruikte domeinen vs. limiet, bijlagenverkeer, reputatieoverzicht, abonnementsstatus, gepubliceerde abonnementen en aantallen in de workspace. Gebruik dit om het resterende quotum te controleren of om te zien naar wie de proefperiode kan afleveren (het e-mailadres van het account).

Geen parameters.

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

Diagnose sending and receiving

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

Geen parameters.

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

Verzendanalytics ophalen

Dashboardanalytics over de laatste 7, 30 of 90 dagen: totalen voor sent/received/delivered/bounced/blocked/opened/clicked/complaint, een dagelijkse tijdlijn, de belangrijkste verzenddomeinen en de meest gebruikte onderwerpen.

ParameterTypeVerplichtBeschrijving
daysintegerneeVenster in dagen: 7, 30 (standaard) of 90. (een van 7, 30, 90)
Retourneert{window, days, metrics, timeline: [{day, sent, received}], domains, topContent}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_analytics",
  "arguments": {
    "days": 30
  }
}
Alleen-lezenlist_api_keys
GET /keys

Metadata van API-sleutels opvragen

Vraagt namen, niet-geheime prefixen en het tijdstip van laatste gebruik van API-sleutels op. Alleen-lezen: deze MCP-server kan geen sleutels aanmaken, roteren of intrekken; dat doet een mens in het dashboard. Gepagineerd: het resultaat bevat pagination {offset, limit, returned, total?, has_more, next_offset}.

ParameterTypeVerplichtBeschrijving
limitintegerneePaginagrootte. Standaard 50. (standaard 50; 1–200)
offsetintegerneeAantal records dat wordt overgeslagen. Gebruik pagination.next_offset van de vorige pagina. (standaard 0; 0–…)
Retourneert{data: [{id, name, prefix, lastUsedAt, createdAt}], count, pagination}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "list_api_keys",
  "arguments": {}
}
Alleen-lezenget_service_health
GET /health

Status van de SendHQ-dienst controleren

Controleert of de SendHQ API bereikbaar is en welke mailprovider actief is. Heeft geen geldige API-sleutel nodig.

Geen parameters.

Retourneert{ok, service, mailer}.
AnnotatiesreadOnlyHint idempotentHint
Voorbeeld van tools/call-params
{
  "name": "get_service_health",
  "arguments": {}
}

Overzicht van de API-dekking

Elke bewerking in de publieke API en de tool die haar dekt. Alles wat een gebruiker in het dashboard kan doen en een API heeft, wordt gedekt; de uitzonderingen hieronder zijn bewust.

EndpointToolOpmerkingen
POST /emailssend_emailEén e-mail verzenden
POST /emails/batchsend_batchMaximaal 100 individuele berichten verzenden
GET /emailslist_emailsVerzonden en ontvangen e-mail opvragen
GET /emails/:idget_emailEen e-mail en de bijlagen ophalen
PATCH /emails/:idmark_emailLeesstatus, archivering, spam, categorie of belangrijkheid bijwerken
POST /emails/:id/labelslabel_emailLabels aan een e-mail toevoegen of ervan verwijderen
DELETE /emails/:iddelete_emailEen bewaarde e-mail verwijderen
GET /emails/:id/eventslist_email_eventsBezorgevents van een e-mail opvragen
GET /threads/:idget_threadEen conversatie in chronologische volgorde ophalen
GET /labelslist_labelsLabels opvragen met aantallen berichten en sorteerregels
POST /labelscreate_labelEen label aanmaken, optioneel met automatische sorteerregels
GET /labels/:idget_labelEen label ophalen op ID of naam
PATCH /labels/:idupdate_labelEen label hernoemen, een andere kleur geven of er een bucket van maken
DELETE /labels/:iddelete_labelEen label verwijderen zonder de e-mail erin te verwijderen
POST /labels/:id/rulescreate_label_ruleEen automatische sorteerregel aan een label toevoegen
DELETE /labels/:id/rules/:rule_iddelete_label_ruleEen automatische sorteerregel verwijderen
POST /draftscreate_draftEen concept in de editor aanmaken
GET /draftslist_draftsConcepten uit de editor opvragen
GET /drafts/:idget_draftEen concept en de bijlagen ophalen
PUT /drafts/:idupdate_draftInhoud van een concept vervangen
DELETE /drafts/:iddelete_draftEen concept weggooien
POST /drafts/:id/attachmentsupload_attachmentEen bijlage uploaden naar een concept
GET /attachments/:iddownload_attachmentEen privébijlage downloaden
DELETE /attachments/:iddelete_attachmentEen privébijlage verwijderen
GET /sending-identitieslist_sending_identitiesGeverifieerde afzenderidentiteiten opvragen
GET /templateslist_templatesGehoste templates opvragen
POST /templatescreate_templateEen gehoste template aanmaken
GET /templates/:idget_templateConcepten, releases en gebruik ophalen
PUT /templates/:id/draftupdate_template_draftEen templateconcept automatisch opslaan
POST /templates/:id/draftcreate_template_draftEen nieuw concept maken op basis van de gepubliceerde release
POST /templates/:id/renderrender_templateDe exacte serveruitvoer renderen
POST /templates/:id/testsend_template_testEen testsnapshot verzenden
POST /templates/:id/publishpublish_templateEen onveranderlijke templaterelease publiceren
POST /templates/:id/archivearchive_templateEen template archiveren
POST /templates/:id/restorerestore_templateEen gearchiveerde template herstellen
POST /domainsadd_domainEen verzenddomein toevoegen
GET /domainslist_domainsDomeinen en gecachte DNS-status opvragen
GET /domains/:idget_domainConfiguratiegegevens van een domein ophalen
POST /domains/:id/verifyverify_domainRefresh domain and DNS verification
POST /domains/:id/inbound/setupsetup_inboundProvision inbound receiving
POST /domains/:id/inbound/verifyverify_inboundInkomende MX-routering verifiëren
DELETE /domains/:iddelete_domainEen domein verwijderen
GET /dns/providerget_dns_providerDe gezaghebbende DNS-provider en relatieve recordhosts detecteren
GET /dns/domain-connect/connectget_domain_connect_linkEen Domain Connect-toestemmingslink maken voor DNS-configuratie met één klik
POST /inboxescreate_inboxEen inkomend adres aanmaken
GET /inboxeslist_inboxesInkomende adressen opvragen
GET /inboxes/:idget_inboxEen inkomend adres ophalen
PATCH /inboxes/:idupdate_inboxEen inbox hernoemen, inschakelen of uitschakelen
PUT /inboxes/:id/forwardingset_inbox_forwardingDe ontvangen e-mail van een inbox doorsturen naar een ander adres
DELETE /inboxes/:iddelete_inboxEen inbox verwijderen en de berichten bewaren
GET /deliverability/statsdeliverability_statsBezorgstatistieken over 30 dagen ophalen
GET /deliverability/reputationlist_sender_reputationReputatiestatus per exacte afzenderidentiteit opvragen
GET /deliverability/accountdeliverability_accountAccount delivery rates, daily ladder, and bounce trend
GET /deliverability/domainsdeliverability_domainsPer-domain sent, delivered, hard and soft bounces, complaints, and failures
GET /deliverability/sendersdeliverability_sendersPer-From-address delivery rates
POST /deliverability/scorescore_emailScore an email's content before it is sent
GET /emails/:id/deliveryemail_deliveryDelivery timeline for one email, with bounce and complaint reasons
GET /threads/:id/deliverythread_deliveryPer-thread delivery counts and per-message failure reasons
GET /suppressionslist_suppressionsSuppressies van de workspace opvragen
DELETE /suppressions/:emailremove_suppressionEen bouncesuppressie verwijderen die daarvoor in aanmerking komt
GET /blocked-recipientslist_blocked_recipientsBounces, klachten en afmeldingen opvragen
GET /webhooksniet beschikbaarWebhook 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 /webhooksniet beschikbaarWebhook 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/:idniet beschikbaarWebhook 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/:idniet beschikbaarWebhook 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/:idniet beschikbaarWebhook 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-secretniet beschikbaarWebhook 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/testniet beschikbaarWebhook 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/deliveriesniet beschikbaarWebhook 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/:deliveryIdniet beschikbaarWebhook 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/retryniet beschikbaarWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
GET /contactslist_contactsList contacts
POST /contactscreate_contactAdd a contact with its consent basis
PUT /contactsupsert_contactCreate or update a contact by email
POST /contacts/bulkbulk_update_contactsTag, move, unsubscribe, or delete many contacts at once
GET /contacts/exportniet beschikbaarImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /contacts/:idget_contactRetrieve a contact by ID or email
PATCH /contacts/:idupdate_contactUpdate a contact's name, fields, or tags, or unsubscribe it
DELETE /contacts/:iddelete_contactDelete a contact and its list memberships
POST /contact-importsimport_contactsImport contacts from CSV
GET /contact-importslist_contact_importsList recent contact imports
GET /tagslist_tagsList contact tags with how many contacts carry each
GET /contact-fieldslist_contact_fieldsList custom contact field definitions
PUT /contact-fields/:keyset_contact_fieldDefine or change a custom contact field
DELETE /contact-fields/:keydelete_contact_fieldDelete a custom field definition
GET /segmentslist_segmentsList saved segments with live counts
POST /segmentscreate_segmentSave a segment
POST /segments/previewpreview_segmentCount and sample the contacts that match unsaved conditions
GET /segments/:idget_segmentRetrieve a segment and its live count
PATCH /segments/:idupdate_segmentRename a segment or change its conditions
DELETE /segments/:iddelete_segmentDelete a segment
GET /listslist_listsList contact lists with member counts
POST /listscreate_listCreate a list with an optional signup form, welcome email, and newsletter site
GET /lists/:idget_listRetrieve a list
PATCH /lists/:idupdate_listRename a list or change its signup form, welcome email, or site
DELETE /lists/:iddelete_listDelete a list without deleting its contacts
POST /lists/:id/contactsadd_list_contactsAdd existing contacts to a list
DELETE /lists/:id/contacts/:contact_idremove_list_contactRemove a contact from a list
GET /broadcastslist_broadcastsList broadcasts
POST /broadcastscreate_broadcastCreate a broadcast draft
GET /broadcasts/:idget_broadcastRetrieve a broadcast and its delivery totals
PATCH /broadcasts/:idupdate_broadcastEdit a draft broadcast
DELETE /broadcasts/:iddelete_broadcastDelete a draft broadcast
GET /broadcasts/:id/checkscheck_broadcastRun the pre-send checks for a broadcast
POST /broadcasts/:id/testsend_broadcast_testSend a test copy of a draft
POST /broadcasts/:id/scheduleschedule_broadcastSchedule a draft to send later
POST /broadcasts/:id/unscheduleunschedule_broadcastUnschedule a draft
POST /broadcasts/:id/duplicateduplicate_broadcastCopy a broadcast into a new draft
POST /broadcasts/:id/sendsend_broadcastSend a broadcast to its audience
POST /broadcasts/:id/send-moresend_broadcast_to_moreSend a sent broadcast to more of its audience
POST /broadcasts/:id/cancelcancel_broadcastCancel a draft or sending broadcast
GET /broadcasts/:id/recipientslist_broadcast_recipientsList a broadcast's recipients, outcomes, and engagement
GET /broadcasts/:id/reportget_broadcast_reportRetrieve a broadcast's engagement report
GET /campaigns/overviewget_campaign_overviewRetrieve subscriber growth and recent broadcast performance
GET /newsletter-settingsget_newsletter_settingsRetrieve newsletter settings
PATCH /newsletter-settingsupdate_newsletter_settingsChange newsletter settings
POST /uploads/imagesniet beschikbaarImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
GET /uploads/imageslist_uploaded_imagesList recently uploaded images
POST /eventstrack_eventRecord something a contact did
POST /events/batchniet beschikbaarHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automationslist_automationsList automations with their 30-day totals
POST /automationscreate_automationCreate an automation as a draft
GET /automations/:keyget_automationRetrieve an automation with its emails
PATCH /automations/:keyupdate_automationEdit an automation
DELETE /automations/:keydelete_automationDelete an automation and its history
PUT /automations/:key/steps/:positionset_automation_stepCreate or change one email of an automation
DELETE /automations/:key/steps/:positiondelete_automation_stepRemove one email from an automation
PUT /automations/:key/steps/:position/variants/:localeset_automation_step_variantCreate or change a language version of an email
POST /automations/:key/steps/:position/testsend_automation_test_emailSend one email of an automation to yourself as a test
POST /automations/:key/testsend_automation_testSend every email of an automation to yourself as tests
POST /automations/:key/statusset_automation_statusTurn an automation on or off
POST /automations/:key/enrollenroll_contactAdd a contact to an automation
POST /automations/:key/exitexit_contactTake a contact out of an automation
GET /automations/:key/previewpreview_automationDry run: what each person in an automation would get now
GET /automations/overviewget_automations_overviewTotals and a daily series across every automation
GET /automations/:key/reportget_automation_reportResults of one automation, with one row per email
GET /automations/:key/peoplelist_automation_peopleList the people in an automation by what they did
GET /automations/:key/people/:contact_idget_automation_personOne person's history in an automation
POST /automations/:key/import-historyniet beschikbaarHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
GET /automation-settingsget_sending_limitsRetrieve the workspace's sending limits for automations
PUT /automation-settingsupdate_sending_limitsChange the workspace's sending limits for automations
GET /automation-librarylist_automation_templatesList the template library: ready-made lifecycle emails
GET /automation-library/:idget_automation_templateRead one template or set, with the email as it will look
POST /automation-library/:id/useuse_automation_templateCreate a draft automation from a template or set
GET /eventslist_eventsList what contacts did, newest first
GET /events/nameslist_event_namesList the kinds of event recorded in the last 30 days
POST /events/previewniet beschikbaarThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connectionslist_connectionsList the workspace's connections (incoming webhooks)
POST /connectionscreate_connectionCreate a connection and get its address
POST /connections/testniet beschikbaarThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.
GET /connections/:idget_connectionRetrieve a connection with its last deliveries
PATCH /connections/:idupdate_connectionChange a connection or switch it on or off
DELETE /connections/:iddelete_connectionDelete a connection
POST /connections/:id/addressniet beschikbaarThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
GET /accountget_accountAccount, gebruik, factureringsstatus en aantallen in de workspace ophalen met een API-sleutel
GET /account/diagnosticsget_account_diagnosticsDiagnose sending and receiving problems in the workspace
GET /analyticsget_analyticsVerzendanalytics uit het dashboard ophalen over 7, 30 of 90 dagen
GET /profileget_accountSessievariant van GET /account; de MCP-server leest de route voor API-sleutels.
POST /billing/checkoutniet beschikbaarFactureringswijzigingen kunnen bewust alleen via een sessie en vereisen de accounteigenaar in het dashboard. De factureringsstatus is leesbaar met get_account.
POST /billing/cancelniet beschikbaarFactureringswijzigingen kunnen bewust alleen via een sessie en vereisen de accounteigenaar in het dashboard. De factureringsstatus is leesbaar met get_account.
POST /keysniet beschikbaarBewust uitgesloten: een agent mag geen credentials aanmaken of vernietigen. Sleutels worden door een mens in het dashboard beheerd.
GET /keyslist_api_keysMetadata van API-sleutels opvragen
DELETE /keys/:idniet beschikbaarBewust uitgesloten: een agent mag geen credentials aanmaken of vernietigen. Sleutels worden door een mens in het dashboard beheerd.

Bewust niet beschikbaar

MogelijkheidEndpointsReden
API-sleutels aanmaken, roteren, intrekken of verwijderenPOST /keys, DELETE /keys/:idBewust uitgesloten: een agent mag geen credentials aanmaken of vernietigen. Sleutels worden door een mens in het dashboard beheerd.
Een checkout starten of een abonnement opzeggenPOST /billing/checkout, POST /billing/cancelFactureringswijzigingen kunnen bewust alleen via een sessie en vereisen de accounteigenaar in het dashboard. De factureringsstatus is leesbaar met get_account.
Cloudflare-DNS met één klik (OAuth)GET /api/dns/cloudflare/connectVereist een interactieve browsersessie en toestemming via Cloudflare OAuth. Gebruik in plaats daarvan de records uit get_domain, de hosts uit get_dns_provider of get_domain_connect_link.
Registreren, inloggen, uitloggen, Google-account koppelen/api/auth/*Authenticatie door een mens in de browser; de MCP-server authenticeert met een API-sleutel.
Contactformulier voor supportPOST /api/contactOpenbaar formulier op de marketingsite voor mensen, geen bewerking in een workspace.
Webhook endpoints and deliveriesGET /webhooks, POST /webhooks, GET /webhooks/:id, PATCH /webhooks/:id, DELETE /webhooks/:id, POST /webhooks/:id/rotate-secret, POST /webhooks/:id/test, GET /webhooks/:id/deliveries, GET /webhooks/:id/deliveries/:deliveryId, POST /webhooks/:id/deliveries/:deliveryId/retryWebhook endpoints are configured once by a human, in the dashboard or the REST API, and their responses carry signing secrets an agent should not hold. An agent reads the same outcomes with list_email_events, list_emails, and list_blocked_recipients.
Upload editor images and export contacts as CSVPOST /uploads/images, GET /contacts/exportImage uploads take a raw binary body and the export returns a CSV file meant for a person to download. Agents reuse uploaded images with list_uploaded_images and read the same contacts, filters, tags, and fields as JSON with list_contacts (paginated).
Import an automation's send history and record events in bulkPOST /automations/:key/import-history, POST /events/batchHistory import is a one-time migration step for the account owner and requires a dashboard session. Bulk events are for server-side backfills through the REST API; an agent records what one person did with track_event, which takes a dedupe_key for safe retries.
Move SendHQ's own win-back emails onto automations (backfill and comparison)POST /automations/platform-backfill, GET /automations/platform-compareInternal cutover tools for SendHQ's own workspace only: they answer nobody else, need its owner's dashboard session, and are not part of the public API or of /api/v1. The backfill enrols SendHQ's own accounts, so it is run by a person, one page at a time, after reading the dry run.
Replace a connection's secret addressPOST /connections/:id/addressThe address is a credential: whoever holds it can record events for the workspace. Replacing it cuts off the system that uses the old one, so a person does it in the dashboard, next to that system's own settings.
Dry runs for a sample payload and for a set of eventsPOST /connections/test, POST /events/previewThese answer the dashboard's connection and spreadsheet screens and take a request body, while this server keeps its read-only tools to GET. An agent sees what a connection did with get_connection, and what an event started with list_events.

Machineleesbare catalogus: /docs/mcp/tools.json (schema's, annotaties, koppeling met endpoints, uitzonderingen). Markdownversie van deze pagina: /docs/mcp.md. Met de CLI geïnstalleerd print sendhq commands --format json dezelfde catalogus.