Reference
Reference nástrojů MCP
Všechny nástroje hostovaného MCP serveru Emailitu seskupené podle sad nástrojů, s druhem, potřebným oprávněním, požadavkem na roli a argumenty.
Hostovaný server na https://api.emailit.com/mcp zpřístupňuje 109 nástrojů v 15 sadách. Tato reference se generuje z katalogu nástrojů serveru, takže vždy odpovídá tomu, co vidí váš asistent. Popisy nástrojů a argumentů se zobrazují tak, jak je server posílá, tedy anglicky.
Oprávnění. Nástroje s oprávněním sending fungují i s full. Viz Workspace a oprávnění.
Druh. Čtení nic nemění. Vytvoření a Úprava mění data. Akce mění stav. Smazání odstraňuje data. Destruktivní nástroje dělají změny, které nelze vrátit zpět. Externí nástroje volají URL, kterou vlastníte. Odeslání se dostane ke skutečným příjemcům. Druhy odpovídají anotacím nástrojů MCP (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), takže se klienti mohou zeptat, než spustí zápisové nástroje.
Workspace. S OAuth přijímá každý nástroj mimo sadu Workspace také volitelný argument workspace (ID nebo přesný název), kterým se dané volání provede v jiném povoleném workspace. Nástroje označené Role Admin se členům workspace s rolí Member odmítnou s chybou admin_role_required. Připojení přes API klíč argument workspace nemají a nevztahují se na ně omezení rolí.
Výsledky. Nástroje vracejí JSON jako text pro všechny klienty a jako structuredContent pro klienty, kteří čtou strukturované výsledky. Nástroje pro výpis přijímají page, limit a strukturované filtry ({ field, condition, value }).
Workspace workspace
get-current-workspaceČtenísendingReturn 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-workspacesČtenísendingJen 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-workspaceÚpravasendingJen 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_idstringpovinnýWorkspace ID or exact name from list-workspaces.
create-workspaceVytvořenífullJen OAuthCreate a new workspace, give this connection access to it, and switch to it.
1 argument
namestringpovinnýWorkspace name.
E-maily emails
send-emailOdeslánísendingSend 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 argumentů
fromstringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.tostring | string[]povinnýRecipient 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-emailsČtenífullList sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.
16 argumentů
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-emailČtenífullRetrieve a single email with its status and delivery details.
1 argument
idstringpovinnýEmail ID (em_xxx).
get-email-rawČtenífullReturn the full raw MIME message of an email.
1 argument
idstringpovinnýEmail ID (em_xxx).
get-email-bodyČtenífullReturn the parsed text and HTML body of an email.
1 argument
idstringpovinnýEmail ID (em_xxx).
get-email-attachmentsČtenífullReturn the attachments of an email.
1 argument
idstringpovinnýEmail ID (em_xxx).
get-email-metaČtenífullReturn email metadata and headers without attachment content.
1 argument
idstringpovinnýEmail ID (em_xxx).
update-emailÚpravasendingChange the send time of a scheduled email.
2 argumenty
idstringpovinnýEmail ID (em_xxx).scheduled_atstringpovinnýNew send time, ISO 8601.
cancel-emailDestruktivnísendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 argument
idstringpovinnýEmail ID (em_xxx).
retry-emailOdeslánísendingRetry delivery of a failed, errored, or held email to its original recipients.
1 argument
idstringpovinnýEmail ID (em_xxx).
forward-emailOdeslánísendingForward 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 argumentů
idstringpovinnýEmail ID (em_xxx).tostring | string[]povinnýNew 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
Domény domains
create-domainVytvořenífullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 argumentů
namestringpovinnýDomain 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-domainČtenífullRetrieve a domain with its DNS records and per-record verification status.
1 argument
idstringpovinnýDomain ID.
list-domainsČtenífullList sending domains in the workspace.
7 argumentů
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-domainÚpravafullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 argumentů
idstringpovinnýDomain 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-domainSmazánífullRole AdminPermanently delete a domain. Sending from it stops immediately.
1 argument
idstringpovinnýDomain ID.
verify-domainAkcefullRun a DNS check now and update the verification status of each record.
1 argument
idstringpovinnýDomain ID.
DMARC dmarc
list-dmarc-reportsČtenífullList DMARC aggregate or forensic reports received for a domain.
11 argumentů
idstringpovinnýDomain 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-reportČtenífullRetrieve one DMARC aggregate report with its records.
2 argumenty
idstringpovinnýDomain ID.report_idstringpovinnýDMARC report ID.
list-dmarc-forensic-reportsČtenífullList DMARC forensic (failure) reports for a domain.
5 argumentů
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportČtenífullRetrieve one DMARC forensic report.
2 argumenty
idstringpovinnýDomain ID.report_idstringpovinnýForensic report ID.
get-dmarc-statsČtenífullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 argumenty
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesČtenífullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 argumenty
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesČtenífullDMARC message volume by sending country.
3 argumenty
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsČtenífullDMARC message volume by sending network (ASN).
3 argumenty
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersČtenífullOrganizations that sent DMARC reports for the domain.
3 argumenty
idstringpovinnýDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportVytvořenífullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 argumenty
idstringpovinnýDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Šablony templates
create-templateVytvořenífullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 argumentů
namestringpovinnýaliasstringpovinnýUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateČtenífullRetrieve a template with its content.
1 argument
idstringpovinnýTemplate ID (tem_xxx).
list-templatesČtenífullList templates in the workspace.
7 argumentů
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-templateÚpravafullUpdate a template draft. Publish it to make the change live.
9 argumentů
idstringpovinnýTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateSmazánífullPermanently delete a template.
1 argument
idstringpovinnýTemplate ID (tem_xxx).
publish-templateAkcefullPublish the current template draft so new sends use it.
1 argument
idstringpovinnýTemplate ID (tem_xxx).
API klíče api_keys
create-api-keyVytvořenífullRole AdminCreate an API key. The secret is returned only once; tell the user to store it securely.
3 argumenty
namestringpovinnýscope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyČtenífullRetrieve an API key (without its secret).
1 argument
idstringpovinnýAPI key ID.
list-api-keysČtenífullList API keys in the workspace.
7 argumentů
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-keyÚpravafullRole AdminRename an API key.
2 argumenty
idstringpovinnýAPI key ID.namestringpovinný
delete-api-keySmazánífullRole AdminPermanently revoke an API key. Apps using it stop working immediately.
1 argument
idstringpovinnýAPI key ID.
regenerate-api-keyDestruktivnífullRole AdminIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 argument
idstringpovinnýAPI key ID.
Seznamy kontaktů a odběratelé audiences
create-audienceVytvořenífullCreate an audience (mailing list) for campaigns and automations.
1 argument
namestringpovinný
get-audienceČtenífullRetrieve an audience with subscriber counts.
1 argument
idstringpovinnýAudience ID.
list-audiencesČtenífullList audiences in the workspace.
7 argumentů
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-audienceÚpravafullRename an audience.
2 argumenty
idstringpovinnýAudience ID.namestringpovinný
delete-audienceSmazánífullPermanently delete an audience and its subscriber records. Contacts are kept.
1 argument
idstringpovinnýAudience ID.
list-audience-subscribersČtenífullList subscribers of an audience, optionally only subscribed or unsubscribed.
9 argumentů
idstringpovinnýAudience 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-subscriberČtenífullRetrieve one subscriber of an audience.
2 argumenty
idstringpovinnýAudience ID.subscriber_idstringpovinnýSubscriber ID.
add-audience-subscriberVytvořenífullAdd an email address to an audience. Creates the contact if it does not exist.
5 argumentů
idstringpovinnýAudience ID.emailstringpovinnýfirst_namestringlast_namestringcustom_fieldsobject
update-audience-subscriberÚpravafullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 argumentů
idstringpovinnýAudience ID.subscriber_idstringpovinnýSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberSmazánífullRemove a subscriber from an audience. The contact is kept.
2 argumenty
idstringpovinnýAudience ID.subscriber_idstringpovinnýSubscriber ID.
Kontakty contacts
create-contactVytvořenífullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 argumentů
emailstringpovinnýfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
get-contactČtenífullRetrieve a contact by ID or email address.
1 argument
idstringpovinnýContact ID (con_xxx) or email address.
list-contactsČtenífullList contacts with search, audience, subscription, and custom-field filters.
9 argumentů
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-contactÚpravafullUpdate a contact. Passing audiences replaces its audience memberships.
7 argumentů
idstringpovinnýContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactSmazánífullPermanently delete a contact and its audience memberships.
1 argument
idstringpovinnýContact ID (con_xxx) or email address.
bulk-update-contactsDestruktivnífullApply one action to up to 100 contacts: delete, add_to_audience, remove_from_audience, unsubscribe, or resubscribe.
3 argumenty
action"delete" | "add_to_audience" | "remove_from_audience" | "unsubscribe" | "resubscribe"povinnýidsstring[]povinnýContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsČtenífullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
9 argumentů
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
Blokované adresy suppressions
create-suppressionVytvořenífullAdd an email address to the suppression list so Emailit never sends to it.
4 argumenty
emailstringpovinný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.
get-suppressionČtenífullRetrieve a suppression by ID or email address.
1 argument
idstringpovinnýSuppression ID (sup_xxx) or email address.
list-suppressionsČtenífullList suppressed addresses with search, type, reason, and expiry filters.
7 argumentů
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-suppressionÚpravafullChange the type, reason, or expiry of a suppression.
4 argumenty
idstringpovinnýSuppression 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-suppressionSmazánífullRemove an address from the suppression list so it can receive email again.
1 argument
idstringpovinnýSuppression ID (sup_xxx) or email address.
Webhooky webhooks
create-webhookVytvořenífullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 argumentů
namestringpovinnýurlstringpovinnýHTTPS 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-webhookČtenífullRetrieve a webhook with its subscribed events and filter.
1 argument
idstringpovinnýWebhook ID (wh_xxx).
list-webhooksČtenífullList webhooks in the workspace.
7 argumentů
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-webhookÚpravafullUpdate a webhook URL, name, events, filter, or enable it again.
7 argumentů
idstringpovinnýWebhook 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-webhookSmazánífullPermanently delete a webhook. Pending deliveries are dropped.
1 argument
idstringpovinnýWebhook ID (wh_xxx).
test-webhookExternífullSend a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.
2 argumenty
idstringpovinnýWebhook 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"povinnýEvent type to send, e.g. email.delivered.
reset-webhook-secretDestruktivnífullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 argument
idstringpovinnýWebhook ID (wh_xxx).
retry-failed-webhook-requestsAkcefullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 argument
idstringpovinnýWebhook ID (wh_xxx).
retry-webhook-requestAkcefullQueue one webhook delivery for retry.
2 argumenty
idstringpovinnýWebhook ID (wh_xxx).request_idstringpovinnýWebhook request ID.
Kampaně campaigns
list-campaignsČtenífullList marketing campaigns, optionally by status.
4 argumenty
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringSearch by name or subject.status"all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignČtenífullRetrieve a campaign with its content, recipients, and stats.
1 argument
idstringpovinnýCampaign ID (cmp_xxx) or name.
create-campaignVytvořenífullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
8 argumentů
namestringpovinnýsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignÚpravafullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 argumentů
idstringpovinnýCampaign 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-campaignSmazánífullPermanently delete a campaign that has not been sent.
1 argument
idstringpovinnýCampaign ID (cmp_xxx) or name.
send-campaignOdeslánífullSend a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.
2 argumenty
idstringpovinnýCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
cancel-campaignDestruktivnífullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 argument
idstringpovinnýCampaign ID (cmp_xxx) or name.
Automatizace automations
list-automationsČtenífullList automations with context, status, and name filters.
7 argumentů
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-automationČtenífullRetrieve an automation with its steps and connections.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
create-automationVytvořenífullCreate a draft automation from a trigger step, action steps, and connections between step keys. Start it with start-automation.
6 argumentů
context"contact" | "email" | "event"povinnýWhat the automation runs on.namestringpovinnýdescriptionstring | nullsettingsobjectstepsobject[]povinnýconnectionsobject[]povinný
update-automationÚpravafullUpdate an automation. Passing steps or connections replaces the whole graph.
6 argumentů
idstringpovinnýAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationSmazánífullDelete an automation and stop any runs in progress.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
start-automationAkcefullStart or resume an automation so new triggers enroll contacts.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
pause-automationAkcefullPause an automation. Runs in progress wait until it is started again.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
stop-automationAkcefullStop an automation and cancel runs in progress.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
trigger-automationOdeslánífullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 argumenty
idstringpovinnýAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsČtenífullList runs of an automation, optionally by status.
4 argumenty
idstringpovinnýAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runČtenífullRetrieve one automation run with its step history.
2 argumenty
idstringpovinnýAutomation ID (aut_xxx).run_idstringpovinnýAutomation run ID.
get-automation-statsČtenífullReturn run totals by status and outcome for an automation.
3 argumenty
idstringpovinnýAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsČtenífullReturn totals for one step, including the delivery funnel for send_email steps.
4 argumenty
idstringpovinnýAutomation ID (aut_xxx).step_keystringpovinnýStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Formuláře forms
list-formsČtenífullList signup forms with name, type, and status filters.
7 argumentů
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-formČtenífullRetrieve a signup form with its definition and settings.
1 argument
idstringpovinnýForm ID (frm_xxx).
create-formVytvořenífullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 argumenty
namestringpovinnýtype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formÚpravafullUpdate a form name, type, definition, or settings.
5 argumentů
idstringpovinnýForm 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-formSmazánífullPermanently delete a form. Embedded copies stop working.
1 argument
idstringpovinnýForm ID (frm_xxx).
publish-formAkcefullPublish a form so it starts collecting signups.
1 argument
idstringpovinnýForm ID (frm_xxx).
unpublish-formAkcefullTake a form offline. It stops collecting signups.
1 argument
idstringpovinnýForm ID (frm_xxx).
reset-form-tokenDestruktivnífullRotate the public form token. Existing embed codes stop working until updated.
1 argument
idstringpovinnýForm ID (frm_xxx).
Ověřování e-mailů verification
verify-emailVytvořenífullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 argumenty
emailstringpovinnýmode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listVytvořenífullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
2 argumenty
namestringpovinnýemailsstring[]povinný
list-verification-listsČtenífullList bulk verification lists with their progress.
4 argumenty
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"searchstring
get-verification-listČtenífullRetrieve a verification list with progress and result counts.
1 argument
idstringpovinnýVerification list ID (evl_xxx).
get-verification-list-resultsČtenífullReturn per-address results of a verification list, optionally by status or result.
5 argumentů
idstringpovinnýVerification 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"
Události events
list-eventsČtenífullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
4 argumenty
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-eventČtenífullRetrieve one event with its full payload.
1 argument
idstringpovinnýEvent ID (evt_xxx).