Zum Inhalt springen
Doku

Referenz

Alle Tools des gehosteten Emailit-MCP-Servers, nach Toolset gruppiert, mit Art, erforderlichem Scope, Rollenanforderung und Argumenten.

Aktualisiert am 2. Okt. 2026

Der gehostete Server unter https://api.emailit.com/mcp stellt 109 Tools in 15 Toolsets bereit. Diese Referenz wird aus dem Tool-Katalog des Servers generiert und entspricht daher immer dem, was Ihr Assistent sieht. Beschreibungen von Tools und Argumenten werden so angezeigt, wie der Server sie sendet, auf Englisch.

Scope. Tools mit dem Scope sending funktionieren auch mit full. Siehe Workspaces und Berechtigungen.

Art. Lesen ändert nichts. Erstellen und Aktualisieren ändern Daten. Aktion ändert einen Zustand. Löschen entfernt Daten. Destruktiv lässt sich nicht rückgängig machen. Extern ruft eine URL auf, die Ihnen gehört. Senden erreicht echte Empfänger. Die Arten entsprechen den MCP-Tool-Annotationen (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), damit Clients nachfragen können, bevor sie schreibende Tools ausführen.

Workspace. Mit OAuth akzeptiert jedes Tool außerhalb des Toolsets Workspace zusätzlich das optionale Argument workspace (ID oder exakter Name), um diesen Aufruf in einem anderen erlaubten Workspace auszuführen. Tools mit der Markierung Admin-Rolle werden für Mitglieder mit der Rolle Member mit admin_role_required abgelehnt. Verbindungen mit API-Schlüssel haben kein Argument workspace und keine Rollenbeschränkungen.

Ergebnisse. Tools geben JSON als Text für jeden Client zurück und als structuredContent für Clients, die strukturierte Ergebnisse lesen. Listen-Tools akzeptieren page, limit und strukturierte Filter ({ field, condition, value }).

Workspace workspace

get-current-workspaceLesensending

Return the Emailit workspace this connection acts on by default, your role in it, and the granted scope. Call it to confirm which account changes apply to.

list-workspacesLesensendingNur OAuth

List the workspaces this connection may use, with your role in each. Pass a workspace ID or name as `workspace` to any tool to act in it.

switch-workspaceAktualisierensendingNur OAuth

Change the default workspace for later tool calls on this connection. To act in another workspace for a single call, pass `workspace` to that tool instead.

1 Argument
  • workspace_id stringerforderlichWorkspace ID or exact name from list-workspaces.
create-workspaceErstellenfullNur OAuth

Create a new workspace, give this connection access to it, and switch to it.

1 Argument
  • name stringerforderlichWorkspace name.

E-Mails emails

send-emailSendensending

Send a transactional email from a verified sending domain. Supports HTML, plain text, templates with variables, attachments, CC/BCC, scheduling, and open/click tracking. Delivers to real recipients, so confirm recipients and content with the user first.

15 Argumente
  • from stringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.
  • to string | string[]erforderlichRecipient email address(es).
  • subject stringSubject line. Optional when a template provides it.
  • html stringHTML body.
  • text stringPlain-text body.
  • reply_to string | string[]
  • cc string | string[]
  • bcc string | string[]
  • template stringTemplate ID (tem_xxx) or alias.
  • variables objectTemplate variables.
  • attachments object[]
  • headers object
  • meta objectCustom metadata returned in events and webhooks.
  • scheduled_at stringISO 8601 time or natural language like "tomorrow at 9am".
  • tracking boolean | object
list-emailsLesenfull

List sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.

16 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: to, from, subject, status, tag, created_at, updated_at, spam_score, api_key_id, sending_domain_id.
  • order "asc" | "desc"Sort direction.
  • type "inbound" | "outbound"
  • status "accepted" | "scheduled" | "clicked" | "loaded" | "delivered" | "bounced" | "attempted" | "failed" | "rejected" | "suppressed" | "received" | "complained" | "canceled" | "held"
  • rcpt_to stringRecipient address contains.
  • mail_from stringSender address contains.
  • subject stringSubject contains.
  • api_key_id string
  • sending_domain_id string
  • date_from stringISO date, inclusive.
  • date_to stringISO date, inclusive.
get-emailLesenfull

Retrieve a single email with its status and delivery details.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
get-email-rawLesenfull

Return the full raw MIME message of an email.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
get-email-bodyLesenfull

Return the parsed text and HTML body of an email.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
get-email-attachmentsLesenfull

Return the attachments of an email.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
get-email-metaLesenfull

Return email metadata and headers without attachment content.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
update-emailAktualisierensending

Change the send time of a scheduled email.

2 Argumente
  • id stringerforderlichEmail ID (em_xxx).
  • scheduled_at stringerforderlichNew send time, ISO 8601.
cancel-emailDestruktivsending

Best-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
retry-emailSendensending

Retry delivery of a failed, errored, or held email to its original recipients.

1 Argument
  • id stringerforderlichEmail ID (em_xxx).
forward-emailSendensending

Forward an outgoing email to a new recipient. Default is a plain resend. Set include_headers to add forwarded headers and an optional comment. Limited to 3 forwards per hour per workspace.

9 Argumente
  • id stringerforderlichEmail ID (em_xxx).
  • to string | string[]erforderlichNew recipient email address(es).
  • include_headers booleanAdd forwarded headers and an optional comment. Default is a plain resend.
  • comment stringNote prepended when include_headers is true.
  • body stringAlias for comment.
  • html string
  • text string
  • from string
  • subject string

Domains domains

create-domainErstellenfull

Add a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.

7 Argumente
  • name stringerforderlichDomain or subdomain, e.g. mail.acme.com.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
get-domainLesenfull

Retrieve a domain with its DNS records and per-record verification status.

1 Argument
  • id stringerforderlichDomain ID.
list-domainsLesenfull

List sending domains in the workspace.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, created_at, spf_status, dkim_status, return_path_status.
  • order "asc" | "desc"Sort direction.
update-domainAktualisierenfull

Update domain settings such as open/click tracking, inbound, or DMARC report collection.

9 Argumente
  • id stringerforderlichDomain ID.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
  • tracking_key string | nullCustom tracking CNAME label.
  • inbound_key string | null
delete-domainLöschenfullAdmin-Rolle

Permanently delete a domain. Sending from it stops immediately.

1 Argument
  • id stringerforderlichDomain ID.
verify-domainAktionfull

Run a DNS check now and update the verification status of each record.

1 Argument
  • id stringerforderlichDomain ID.

DMARC dmarc

list-dmarc-reportsLesenfull

List DMARC aggregate or forensic reports received for a domain.

11 Argumente
  • id stringerforderlichDomain ID.
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • type "aggregate" | "forensic"
  • status string
  • org_name stringReporting organization, e.g. google.com.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • offset number
get-dmarc-reportLesenfull

Retrieve one DMARC aggregate report with its records.

2 Argumente
  • id stringerforderlichDomain ID.
  • report_id stringerforderlichDMARC report ID.
list-dmarc-forensic-reportsLesenfull

List DMARC forensic (failure) reports for a domain.

5 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportLesenfull

Retrieve one DMARC forensic report.

2 Argumente
  • id stringerforderlichDomain ID.
  • report_id stringerforderlichForensic report ID.
get-dmarc-statsLesenfull

DMARC pass/fail totals and alignment rates for a domain over a date range.

3 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesLesenfull

Sending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.

3 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesLesenfull

DMARC message volume by sending country.

3 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsLesenfull

DMARC message volume by sending network (ASN).

3 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersLesenfull

Organizations that sent DMARC reports for the domain.

3 Argumente
  • id stringerforderlichDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportErstellenfull

Import a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.

4 Argumente
  • id stringerforderlichDomain ID.
  • content stringRaw report XML.
  • content_base64 stringBase64 of the report file.
  • filename string

Vorlagen templates

create-templateErstellenfull

Create an email template. Reference it from send-email by ID or alias; publish it before use.

8 Argumente
  • name stringerforderlich
  • alias stringerforderlichUnique slug used by send-email.
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
get-templateLesenfull

Retrieve a template with its content.

1 Argument
  • id stringerforderlichTemplate ID (tem_xxx).
list-templatesLesenfull

List templates in the workspace.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, alias, editor, subject, created_at.
  • order "asc" | "desc"Sort direction.
  • include_content booleanInclude HTML and text bodies.
update-templateAktualisierenfull

Update a template draft. Publish it to make the change live.

9 Argumente
  • id stringerforderlichTemplate ID (tem_xxx).
  • name string
  • alias string
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
delete-templateLöschenfull

Permanently delete a template.

1 Argument
  • id stringerforderlichTemplate ID (tem_xxx).
publish-templateAktionfull

Publish the current template draft so new sends use it.

1 Argument
  • id stringerforderlichTemplate ID (tem_xxx).

API-Schlüssel api_keys

create-api-keyErstellenfullAdmin-Rolle

Create an API key. The secret is returned only once; tell the user to store it securely.

3 Argumente
  • name stringerforderlich
  • scope "full" | "sending"sending = send-only, full = every endpoint.
  • sending_domain_id string | nullLock a sending key to one domain.
get-api-keyLesenfull

Retrieve an API key (without its secret).

1 Argument
  • id stringerforderlichAPI key ID.
list-api-keysLesenfull

List API keys in the workspace.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, type, scope, created_at.
  • order "asc" | "desc"Sort direction.
update-api-keyAktualisierenfullAdmin-Rolle

Rename an API key.

2 Argumente
  • id stringerforderlichAPI key ID.
  • name stringerforderlich
delete-api-keyLöschenfullAdmin-Rolle

Permanently revoke an API key. Apps using it stop working immediately.

1 Argument
  • id stringerforderlichAPI key ID.
regenerate-api-keyDestruktivfullAdmin-Rolle

Issue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.

1 Argument
  • id stringerforderlichAPI key ID.

Kontaktlisten und Abonnenten audiences

create-audienceErstellenfull

Create an audience (mailing list) for campaigns and automations.

1 Argument
  • name stringerforderlich
get-audienceLesenfull

Retrieve an audience with subscriber counts.

1 Argument
  • id stringerforderlichAudience ID.
list-audiencesLesenfull

List audiences in the workspace.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, created_at.
  • order "asc" | "desc"Sort direction.
update-audienceAktualisierenfull

Rename an audience.

2 Argumente
  • id stringerforderlichAudience ID.
  • name stringerforderlich
delete-audienceLöschenfull

Permanently delete an audience and its subscriber records. Contacts are kept.

1 Argument
  • id stringerforderlichAudience ID.
list-audience-subscribersLesenfull

List subscribers of an audience, optionally only subscribed or unsubscribed.

9 Argumente
  • id stringerforderlichAudience ID.
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: email, first_name, last_name, subscribed, created_at.
  • order "asc" | "desc"Sort direction.
  • subscribed boolean
get-audience-subscriberLesenfull

Retrieve one subscriber of an audience.

2 Argumente
  • id stringerforderlichAudience ID.
  • subscriber_id stringerforderlichSubscriber ID.
add-audience-subscriberErstellenfull

Add an email address to an audience. Creates the contact if it does not exist.

5 Argumente
  • id stringerforderlichAudience ID.
  • email stringerforderlich
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberAktualisierenfull

Update a subscriber, including subscribing or unsubscribing them from the audience.

7 Argumente
  • id stringerforderlichAudience ID.
  • subscriber_id stringerforderlichSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberLöschenfull

Remove a subscriber from an audience. The contact is kept.

2 Argumente
  • id stringerforderlichAudience ID.
  • subscriber_id stringerforderlichSubscriber ID.

Kontakte contacts

create-contactErstellenfull

Create a contact, optionally subscribing it to audiences and setting custom fields.

6 Argumente
  • email stringerforderlich
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactLesenfull

Retrieve a contact by ID or email address.

1 Argument
  • id stringerforderlichContact ID (con_xxx) or email address.
list-contactsLesenfull

List contacts with search, audience, subscription, and custom-field filters.

9 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, audience_id, custom_fields.<key>.
  • order "asc" | "desc"Sort direction.
  • audience_id stringOnly contacts in this audience.
  • unsubscribed boolean
update-contactAktualisierenfull

Update a contact. Passing audiences replaces its audience memberships.

7 Argumente
  • id stringerforderlichContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactLöschenfull

Permanently delete a contact and its audience memberships.

1 Argument
  • id stringerforderlichContact ID (con_xxx) or email address.
bulk-update-contactsDestruktivfull

Apply one action to up to 100 contacts: delete, add_to_audience, remove_from_audience, unsubscribe, or resubscribe.

3 Argumente
  • action "delete" | "add_to_audience" | "remove_from_audience" | "unsubscribe" | "resubscribe"erforderlich
  • ids string[]erforderlichContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsLesenfull

Export contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).

9 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, audience_id, custom_fields.<key>.
  • order "asc" | "desc"Sort direction.
  • audience_id stringOnly contacts in this audience.
  • unsubscribed boolean

Sperrungen suppressions

create-suppressionErstellenfull

Add an email address to the suppression list so Emailit never sends to it.

4 Argumente
  • email stringerforderlich
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
get-suppressionLesenfull

Retrieve a suppression by ID or email address.

1 Argument
  • id stringerforderlichSuppression ID (sup_xxx) or email address.
list-suppressionsLesenfull

List suppressed addresses with search, type, reason, and expiry filters.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: email, reason, type, created_at, keep_until.
  • order "asc" | "desc"Sort direction.
update-suppressionAktualisierenfull

Change the type, reason, or expiry of a suppression.

4 Argumente
  • id stringerforderlichSuppression ID (sup_xxx) or email address.
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
delete-suppressionLöschenfull

Remove an address from the suppression list so it can receive email again.

1 Argument
  • id stringerforderlichSuppression ID (sup_xxx) or email address.

Webhooks webhooks

create-webhookErstellenfull

Create a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.

6 Argumente
  • name stringerforderlich
  • url stringerforderlichHTTPS endpoint that receives event POSTs.
  • all_events booleanSubscribe to every event type.
  • enabled boolean
  • events "email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"[]Event types to subscribe to when all_events is false.
  • filter object | nullOnly deliver events matching these rules. Null clears the filter.
get-webhookLesenfull

Retrieve a webhook with its subscribed events and filter.

1 Argument
  • id stringerforderlichWebhook ID (wh_xxx).
list-webhooksLesenfull

List webhooks in the workspace.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, url, enabled, created_at.
  • order "asc" | "desc"Sort direction.
update-webhookAktualisierenfull

Update a webhook URL, name, events, filter, or enable it again.

7 Argumente
  • id stringerforderlichWebhook ID (wh_xxx).
  • name string
  • url stringHTTPS endpoint that receives event POSTs.
  • all_events booleanSubscribe to every event type.
  • enabled boolean
  • events "email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"[]Event types to subscribe to when all_events is false.
  • filter object | nullOnly deliver events matching these rules. Null clears the filter.
delete-webhookLöschenfull

Permanently delete a webhook. Pending deliveries are dropped.

1 Argument
  • id stringerforderlichWebhook ID (wh_xxx).
test-webhookExternfull

Send a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.

2 Argumente
  • id stringerforderlichWebhook ID (wh_xxx).
  • type "email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"erforderlichEvent type to send, e.g. email.delivered.
reset-webhook-secretDestruktivfull

Rotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.

1 Argument
  • id stringerforderlichWebhook ID (wh_xxx).
retry-failed-webhook-requestsAktionfull

Queue every failed delivery of a webhook for retry and re-enable the webhook.

1 Argument
  • id stringerforderlichWebhook ID (wh_xxx).
retry-webhook-requestAktionfull

Queue one webhook delivery for retry.

2 Argumente
  • id stringerforderlichWebhook ID (wh_xxx).
  • request_id stringerforderlichWebhook request ID.

Kampagnen campaigns

list-campaignsLesenfull

List marketing campaigns, optionally by status.

4 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringSearch by name or subject.
  • status "all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignLesenfull

Retrieve a campaign with its content, recipients, and stats.

1 Argument
  • id stringerforderlichCampaign ID (cmp_xxx) or name.
create-campaignErstellenfull

Create a draft campaign. Add recipients with update-campaign, then send with send-campaign.

8 Argumente
  • name stringerforderlich
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
update-campaignAktualisierenfull

Update a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.

10 Argumente
  • id stringerforderlichCampaign ID (cmp_xxx) or name.
  • name string
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
  • recipients object[]
delete-campaignLöschenfull

Permanently delete a campaign that has not been sent.

1 Argument
  • id stringerforderlichCampaign ID (cmp_xxx) or name.
send-campaignSendenfull

Send a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.

2 Argumente
  • id stringerforderlichCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDestruktivfull

Cancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.

1 Argument
  • id stringerforderlichCampaign ID (cmp_xxx) or name.

Automatisierungen automations

list-automationsLesenfull

List automations with context, status, and name filters.

7 Argumente
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • context "contact" | "email" | "event"
  • status "draft" | "running" | "paused" | "stopped" | "archived"
  • name stringName contains.
  • sort "name" | "created_at" | "updated_at" | "last_triggered_at"
  • order "asc" | "desc"
get-automationLesenfull

Retrieve an automation with its steps and connections.

1 Argument
  • id stringerforderlichAutomation ID (aut_xxx).
create-automationErstellenfull

Create a draft automation from a trigger step, action steps, and connections between step keys. Start it with start-automation.

6 Argumente
  • context "contact" | "email" | "event"erforderlichWhat the automation runs on.
  • name stringerforderlich
  • description string | null
  • settings object
  • steps object[]erforderlich
  • connections object[]erforderlich
update-automationAktualisierenfull

Update an automation. Passing steps or connections replaces the whole graph.

6 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationLöschenfull

Delete an automation and stop any runs in progress.

1 Argument
  • id stringerforderlichAutomation ID (aut_xxx).
start-automationAktionfull

Start or resume an automation so new triggers enroll contacts.

1 Argument
  • id stringerforderlichAutomation ID (aut_xxx).
pause-automationAktionfull

Pause an automation. Runs in progress wait until it is started again.

1 Argument
  • id stringerforderlichAutomation ID (aut_xxx).
stop-automationAktionfull

Stop an automation and cancel runs in progress.

1 Argument
  • id stringerforderlichAutomation ID (aut_xxx).
trigger-automationSendenfull

Manually trigger a running automation with an optional payload. Its steps may send real emails.

2 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • payload objectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLesenfull

List runs of an automation, optionally by status.

4 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLesenfull

Retrieve one automation run with its step history.

2 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • run_id stringerforderlichAutomation run ID.
get-automation-statsLesenfull

Return run totals by status and outcome for an automation.

3 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsLesenfull

Return totals for one step, including the delivery funnel for send_email steps.

4 Argumente
  • id stringerforderlichAutomation ID (aut_xxx).
  • step_key stringerforderlichStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Formulare forms

list-formsLesenfull

List signup forms with name, type, and status filters.

7 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search stringFree-text search.
  • filters object[]Structured filters, combined with AND unless match is "or".
  • match "all" | "or"Combine filters with AND (all, default) or OR.
  • sort stringSort column: name, type, status, created_at.
  • order "asc" | "desc"Sort direction.
get-formLesenfull

Retrieve a signup form with its definition and settings.

1 Argument
  • id stringerforderlichForm ID (frm_xxx).
create-formErstellenfull

Create a draft signup form (popup, full page, flyout, embed, or banner).

4 Argumente
  • name stringerforderlich
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
update-formAktualisierenfull

Update a form name, type, definition, or settings.

5 Argumente
  • id stringerforderlichForm ID (frm_xxx).
  • name string
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
delete-formLöschenfull

Permanently delete a form. Embedded copies stop working.

1 Argument
  • id stringerforderlichForm ID (frm_xxx).
publish-formAktionfull

Publish a form so it starts collecting signups.

1 Argument
  • id stringerforderlichForm ID (frm_xxx).
unpublish-formAktionfull

Take a form offline. It stops collecting signups.

1 Argument
  • id stringerforderlichForm ID (frm_xxx).
reset-form-tokenDestruktivfull

Rotate the public form token. Existing embed codes stop working until updated.

1 Argument
  • id stringerforderlichForm ID (frm_xxx).

E-Mail-Verifizierung verification

verify-emailErstellenfull

Check whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.

2 Argumente
  • email stringerforderlich
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listErstellenfull

Verify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.

2 Argumente
  • name stringerforderlich
  • emails string[]erforderlich
list-verification-listsLesenfull

List bulk verification lists with their progress.

4 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • status "pending" | "processing" | "completed" | "failed" | "canceled"
  • search string
get-verification-listLesenfull

Retrieve a verification list with progress and result counts.

1 Argument
  • id stringerforderlichVerification list ID (evl_xxx).
get-verification-list-resultsLesenfull

Return per-address results of a verification list, optionally by status or result.

5 Argumente
  • id stringerforderlichVerification list ID (evl_xxx).
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • status "pending" | "processing" | "completed" | "failed" | "canceled"
  • result "safe" | "invalid" | "disposable" | "disabled" | "inbox_full" | "unknown"

Events events

list-eventsLesenfull

List workspace events (email delivered, bounced, clicked, contact created, and more), newest first.

4 Argumente
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • type stringEvent type or comma-separated types, e.g. "email.bounced,email.complained".
  • include_data booleanInclude the full event payload. Default false.
get-eventLesenfull

Retrieve one event with its full payload.

1 Argument
  • id stringerforderlichEvent ID (evt_xxx).

War diese Seite hilfreich?

Danke für Ihr Feedback.

Danke, wir lesen jede Nachricht.