Referenz
MCP-Tool-Referenz
Alle Tools des gehosteten Emailit-MCP-Servers, nach Toolset gruppiert, mit Art, erforderlichem Scope, Rollenanforderung und Argumenten.
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-workspaceLesensendingReturn 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 OAuthList 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 OAuthChange 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_idstringerforderlichWorkspace ID or exact name from list-workspaces.
create-workspaceErstellenfullNur OAuthCreate a new workspace, give this connection access to it, and switch to it.
1 Argument
namestringerforderlichWorkspace name.
E-Mails emails
send-emailSendensendingSend 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
fromstringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.tostring | string[]erforderlichRecipient email address(es).subjectstringSubject line. Optional when a template provides it.htmlstringHTML body.textstringPlain-text body.reply_tostring | string[]ccstring | string[]bccstring | string[]templatestringTemplate ID (tem_xxx) or alias.variablesobjectTemplate variables.attachmentsobject[]headersobjectmetaobjectCustom metadata returned in events and webhooks.scheduled_atstringISO 8601 time or natural language like "tomorrow at 9am".trackingboolean | object
list-emailsLesenfullList sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.
16 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort 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_tostringRecipient address contains.mail_fromstringSender address contains.subjectstringSubject contains.api_key_idstringsending_domain_idstringdate_fromstringISO date, inclusive.date_tostringISO date, inclusive.
get-emailLesenfullRetrieve a single email with its status and delivery details.
1 Argument
idstringerforderlichEmail ID (em_xxx).
get-email-rawLesenfullReturn the full raw MIME message of an email.
1 Argument
idstringerforderlichEmail ID (em_xxx).
get-email-bodyLesenfullReturn the parsed text and HTML body of an email.
1 Argument
idstringerforderlichEmail ID (em_xxx).
get-email-attachmentsLesenfullReturn the attachments of an email.
1 Argument
idstringerforderlichEmail ID (em_xxx).
get-email-metaLesenfullReturn email metadata and headers without attachment content.
1 Argument
idstringerforderlichEmail ID (em_xxx).
update-emailAktualisierensendingChange the send time of a scheduled email.
2 Argumente
idstringerforderlichEmail ID (em_xxx).scheduled_atstringerforderlichNew send time, ISO 8601.
cancel-emailDestruktivsendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 Argument
idstringerforderlichEmail ID (em_xxx).
retry-emailSendensendingRetry delivery of a failed, errored, or held email to its original recipients.
1 Argument
idstringerforderlichEmail ID (em_xxx).
forward-emailSendensendingForward 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
idstringerforderlichEmail ID (em_xxx).tostring | string[]erforderlichNew recipient email address(es).include_headersbooleanAdd forwarded headers and an optional comment. Default is a plain resend.commentstringNote prepended when include_headers is true.bodystringAlias for comment.htmlstringtextstringfromstringsubjectstring
Domains domains
create-domainErstellenfullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 Argumente
namestringerforderlichDomain or subdomain, e.g. mail.acme.com.outgoingbooleanAllow sending from this domain.incomingbooleanAccept inbound email for this domain.use_for_anybooleantrack_loadsbooleanTrack opens.track_clicksbooleanTrack link clicks.dmarc_reportsbooleanCollect DMARC aggregate reports.
get-domainLesenfullRetrieve a domain with its DNS records and per-record verification status.
1 Argument
idstringerforderlichDomain ID.
list-domainsLesenfullList sending domains in the workspace.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, created_at, spf_status, dkim_status, return_path_status.order"asc" | "desc"Sort direction.
update-domainAktualisierenfullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 Argumente
idstringerforderlichDomain ID.outgoingbooleanAllow sending from this domain.incomingbooleanAccept inbound email for this domain.use_for_anybooleantrack_loadsbooleanTrack opens.track_clicksbooleanTrack link clicks.dmarc_reportsbooleanCollect DMARC aggregate reports.tracking_keystring | nullCustom tracking CNAME label.inbound_keystring | null
delete-domainLöschenfullAdmin-RollePermanently delete a domain. Sending from it stops immediately.
1 Argument
idstringerforderlichDomain ID.
verify-domainAktionfullRun a DNS check now and update the verification status of each record.
1 Argument
idstringerforderlichDomain ID.
DMARC dmarc
list-dmarc-reportsLesenfullList DMARC aggregate or forensic reports received for a domain.
11 Argumente
idstringerforderlichDomain ID.pagenumberPage number (default: 1).limitnumberResults per page (max: 100).filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.type"aggregate" | "forensic"statusstringorg_namestringReporting organization, e.g. google.com.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.offsetnumber
get-dmarc-reportLesenfullRetrieve one DMARC aggregate report with its records.
2 Argumente
idstringerforderlichDomain ID.report_idstringerforderlichDMARC report ID.
list-dmarc-forensic-reportsLesenfullList DMARC forensic (failure) reports for a domain.
5 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportLesenfullRetrieve one DMARC forensic report.
2 Argumente
idstringerforderlichDomain ID.report_idstringerforderlichForensic report ID.
get-dmarc-statsLesenfullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesLesenfullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesLesenfullDMARC message volume by sending country.
3 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsLesenfullDMARC message volume by sending network (ASN).
3 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersLesenfullOrganizations that sent DMARC reports for the domain.
3 Argumente
idstringerforderlichDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportErstellenfullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 Argumente
idstringerforderlichDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Vorlagen templates
create-templateErstellenfullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 Argumente
namestringerforderlichaliasstringerforderlichUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateLesenfullRetrieve a template with its content.
1 Argument
idstringerforderlichTemplate ID (tem_xxx).
list-templatesLesenfullList templates in the workspace.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, alias, editor, subject, created_at.order"asc" | "desc"Sort direction.include_contentbooleanInclude HTML and text bodies.
update-templateAktualisierenfullUpdate a template draft. Publish it to make the change live.
9 Argumente
idstringerforderlichTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateLöschenfullPermanently delete a template.
1 Argument
idstringerforderlichTemplate ID (tem_xxx).
publish-templateAktionfullPublish the current template draft so new sends use it.
1 Argument
idstringerforderlichTemplate ID (tem_xxx).
API-Schlüssel api_keys
create-api-keyErstellenfullAdmin-RolleCreate an API key. The secret is returned only once; tell the user to store it securely.
3 Argumente
namestringerforderlichscope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyLesenfullRetrieve an API key (without its secret).
1 Argument
idstringerforderlichAPI key ID.
list-api-keysLesenfullList API keys in the workspace.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, type, scope, created_at.order"asc" | "desc"Sort direction.
update-api-keyAktualisierenfullAdmin-RolleRename an API key.
2 Argumente
idstringerforderlichAPI key ID.namestringerforderlich
delete-api-keyLöschenfullAdmin-RollePermanently revoke an API key. Apps using it stop working immediately.
1 Argument
idstringerforderlichAPI key ID.
regenerate-api-keyDestruktivfullAdmin-RolleIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 Argument
idstringerforderlichAPI key ID.
Kontaktlisten und Abonnenten audiences
create-audienceErstellenfullCreate an audience (mailing list) for campaigns and automations.
1 Argument
namestringerforderlich
get-audienceLesenfullRetrieve an audience with subscriber counts.
1 Argument
idstringerforderlichAudience ID.
list-audiencesLesenfullList audiences in the workspace.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, created_at.order"asc" | "desc"Sort direction.
update-audienceAktualisierenfullRename an audience.
2 Argumente
idstringerforderlichAudience ID.namestringerforderlich
delete-audienceLöschenfullPermanently delete an audience and its subscriber records. Contacts are kept.
1 Argument
idstringerforderlichAudience ID.
list-audience-subscribersLesenfullList subscribers of an audience, optionally only subscribed or unsubscribed.
9 Argumente
idstringerforderlichAudience ID.pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, subscribed, created_at.order"asc" | "desc"Sort direction.subscribedboolean
get-audience-subscriberLesenfullRetrieve one subscriber of an audience.
2 Argumente
idstringerforderlichAudience ID.subscriber_idstringerforderlichSubscriber ID.
add-audience-subscriberErstellenfullAdd an email address to an audience. Creates the contact if it does not exist.
5 Argumente
idstringerforderlichAudience ID.emailstringerforderlichfirst_namestringlast_namestringcustom_fieldsobject
update-audience-subscriberAktualisierenfullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 Argumente
idstringerforderlichAudience ID.subscriber_idstringerforderlichSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberLöschenfullRemove a subscriber from an audience. The contact is kept.
2 Argumente
idstringerforderlichAudience ID.subscriber_idstringerforderlichSubscriber ID.
Kontakte contacts
create-contactErstellenfullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 Argumente
emailstringerforderlichfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
get-contactLesenfullRetrieve a contact by ID or email address.
1 Argument
idstringerforderlichContact ID (con_xxx) or email address.
list-contactsLesenfullList contacts with search, audience, subscription, and custom-field filters.
9 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedboolean
update-contactAktualisierenfullUpdate a contact. Passing audiences replaces its audience memberships.
7 Argumente
idstringerforderlichContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactLöschenfullPermanently delete a contact and its audience memberships.
1 Argument
idstringerforderlichContact ID (con_xxx) or email address.
bulk-update-contactsDestruktivfullApply 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"erforderlichidsstring[]erforderlichContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsLesenfullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
9 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedboolean
Sperrungen suppressions
create-suppressionErstellenfullAdd an email address to the suppression list so Emailit never sends to it.
4 Argumente
emailstringerforderlichtype"recipient" | "bounce" | "complaint" | "unsubscribe"reasonstringkeep_untilstring | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
get-suppressionLesenfullRetrieve a suppression by ID or email address.
1 Argument
idstringerforderlichSuppression ID (sup_xxx) or email address.
list-suppressionsLesenfullList suppressed addresses with search, type, reason, and expiry filters.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, reason, type, created_at, keep_until.order"asc" | "desc"Sort direction.
update-suppressionAktualisierenfullChange the type, reason, or expiry of a suppression.
4 Argumente
idstringerforderlichSuppression ID (sup_xxx) or email address.type"recipient" | "bounce" | "complaint" | "unsubscribe"reasonstringkeep_untilstring | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
delete-suppressionLöschenfullRemove an address from the suppression list so it can receive email again.
1 Argument
idstringerforderlichSuppression ID (sup_xxx) or email address.
Webhooks webhooks
create-webhookErstellenfullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 Argumente
namestringerforderlichurlstringerforderlichHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every event type.enabledbooleanevents"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.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
get-webhookLesenfullRetrieve a webhook with its subscribed events and filter.
1 Argument
idstringerforderlichWebhook ID (wh_xxx).
list-webhooksLesenfullList webhooks in the workspace.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, url, enabled, created_at.order"asc" | "desc"Sort direction.
update-webhookAktualisierenfullUpdate a webhook URL, name, events, filter, or enable it again.
7 Argumente
idstringerforderlichWebhook ID (wh_xxx).namestringurlstringHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every event type.enabledbooleanevents"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.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
delete-webhookLöschenfullPermanently delete a webhook. Pending deliveries are dropped.
1 Argument
idstringerforderlichWebhook ID (wh_xxx).
test-webhookExternfullSend a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.
2 Argumente
idstringerforderlichWebhook 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-secretDestruktivfullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 Argument
idstringerforderlichWebhook ID (wh_xxx).
retry-failed-webhook-requestsAktionfullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 Argument
idstringerforderlichWebhook ID (wh_xxx).
retry-webhook-requestAktionfullQueue one webhook delivery for retry.
2 Argumente
idstringerforderlichWebhook ID (wh_xxx).request_idstringerforderlichWebhook request ID.
Kampagnen campaigns
list-campaignsLesenfullList marketing campaigns, optionally by status.
4 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringSearch by name or subject.status"all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignLesenfullRetrieve a campaign with its content, recipients, and stats.
1 Argument
idstringerforderlichCampaign ID (cmp_xxx) or name.
create-campaignErstellenfullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
8 Argumente
namestringerforderlichsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignAktualisierenfullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 Argumente
idstringerforderlichCampaign ID (cmp_xxx) or name.namestringsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"recipientsobject[]
delete-campaignLöschenfullPermanently delete a campaign that has not been sent.
1 Argument
idstringerforderlichCampaign ID (cmp_xxx) or name.
send-campaignSendenfullSend a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.
2 Argumente
idstringerforderlichCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
cancel-campaignDestruktivfullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 Argument
idstringerforderlichCampaign ID (cmp_xxx) or name.
Automatisierungen automations
list-automationsLesenfullList automations with context, status, and name filters.
7 Argumente
pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).context"contact" | "email" | "event"status"draft" | "running" | "paused" | "stopped" | "archived"namestringName contains.sort"name" | "created_at" | "updated_at" | "last_triggered_at"order"asc" | "desc"
get-automationLesenfullRetrieve an automation with its steps and connections.
1 Argument
idstringerforderlichAutomation ID (aut_xxx).
create-automationErstellenfullCreate 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.namestringerforderlichdescriptionstring | nullsettingsobjectstepsobject[]erforderlichconnectionsobject[]erforderlich
update-automationAktualisierenfullUpdate an automation. Passing steps or connections replaces the whole graph.
6 Argumente
idstringerforderlichAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationLöschenfullDelete an automation and stop any runs in progress.
1 Argument
idstringerforderlichAutomation ID (aut_xxx).
start-automationAktionfullStart or resume an automation so new triggers enroll contacts.
1 Argument
idstringerforderlichAutomation ID (aut_xxx).
pause-automationAktionfullPause an automation. Runs in progress wait until it is started again.
1 Argument
idstringerforderlichAutomation ID (aut_xxx).
stop-automationAktionfullStop an automation and cancel runs in progress.
1 Argument
idstringerforderlichAutomation ID (aut_xxx).
trigger-automationSendenfullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 Argumente
idstringerforderlichAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLesenfullList runs of an automation, optionally by status.
4 Argumente
idstringerforderlichAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLesenfullRetrieve one automation run with its step history.
2 Argumente
idstringerforderlichAutomation ID (aut_xxx).run_idstringerforderlichAutomation run ID.
get-automation-statsLesenfullReturn run totals by status and outcome for an automation.
3 Argumente
idstringerforderlichAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsLesenfullReturn totals for one step, including the delivery funnel for send_email steps.
4 Argumente
idstringerforderlichAutomation ID (aut_xxx).step_keystringerforderlichStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Formulare forms
list-formsLesenfullList signup forms with name, type, and status filters.
7 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, type, status, created_at.order"asc" | "desc"Sort direction.
get-formLesenfullRetrieve a signup form with its definition and settings.
1 Argument
idstringerforderlichForm ID (frm_xxx).
create-formErstellenfullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 Argumente
namestringerforderlichtype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formAktualisierenfullUpdate a form name, type, definition, or settings.
5 Argumente
idstringerforderlichForm ID (frm_xxx).namestringtype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
delete-formLöschenfullPermanently delete a form. Embedded copies stop working.
1 Argument
idstringerforderlichForm ID (frm_xxx).
publish-formAktionfullPublish a form so it starts collecting signups.
1 Argument
idstringerforderlichForm ID (frm_xxx).
unpublish-formAktionfullTake a form offline. It stops collecting signups.
1 Argument
idstringerforderlichForm ID (frm_xxx).
reset-form-tokenDestruktivfullRotate the public form token. Existing embed codes stop working until updated.
1 Argument
idstringerforderlichForm ID (frm_xxx).
E-Mail-Verifizierung verification
verify-emailErstellenfullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 Argumente
emailstringerforderlichmode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listErstellenfullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
2 Argumente
namestringerforderlichemailsstring[]erforderlich
list-verification-listsLesenfullList bulk verification lists with their progress.
4 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"searchstring
get-verification-listLesenfullRetrieve a verification list with progress and result counts.
1 Argument
idstringerforderlichVerification list ID (evl_xxx).
get-verification-list-resultsLesenfullReturn per-address results of a verification list, optionally by status or result.
5 Argumente
idstringerforderlichVerification list ID (evl_xxx).pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"result"safe" | "invalid" | "disposable" | "disabled" | "inbox_full" | "unknown"
Events events
list-eventsLesenfullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
4 Argumente
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).typestringEvent type or comma-separated types, e.g. "email.bounced,email.complained".include_databooleanInclude the full event payload. Default false.
get-eventLesenfullRetrieve one event with its full payload.
1 Argument
idstringerforderlichEvent ID (evt_xxx).