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 135 nástrojů v 16 sadách a navíc sady segments a commerce a několik dalších nástrojů v alfaverzi, které se vypisují jen v relacích týmu Emailitu. 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 komunikují se systémy mimo Emailit, například s URL vašeho webhooku, DNS nebo poštovními servery. 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, up to 100 characters.
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-domainExternífullLook up the domain's DNS records 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).
get-mjml-referenceČtenífullAlfaMJML components, attributes and defaults for the MJML version Emailit compiles with, the Temple variable guide ({{first_name}}, {{#if}}) and authoring rules. Read it before writing an MJML template or campaign.
validate-mjmlČtenífullAlfaCheck MJML before saving it with create-template or update-template (editor mjml) or as campaign content. Returns valid and diagnostics (severity, code, message, line, tag, attribute); fix every error and validate again.
1 argument
sourcestringpovinnýMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.
render-mjmlČtenífullAlfaCompile MJML to the HTML Emailit sends. Pass variables, e.g. {"first_name":"Ada","cf":{"plan":"Pro"}}, to also get rendered_html with Temple applied as one recipient would see it.
2 argumenty
sourcestringpovinnýMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.variablesobjectTemple variables for rendered_html.
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, optionally with its settings.
7 argumentů
namestringpovinnývisibility"public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.public_namestringName shown to subscribers instead of the internal name.public_descriptionstringShort description shown on the manage subscriptions page.double_opt_inobjectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.confirmation_emailobjectEmail sent after someone subscribes or confirms.unengagedobject
get-audienceČtenífullRetrieve an audience with its settings, subscriber, unengaged and pending double opt-in counts.
1 argument
idstringpovinnýAudience ID.
list-audiencesČtenífullList audiences in the workspace. Archived audiences are hidden unless archived is "true" or "all".
8 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, public_name, visibility, subscribers_count, created_at.order"asc" | "desc"Sort direction.archived"true" | "false" | "all"
update-audienceÚpravafullRename an audience or change its settings: visibility, public name, double opt-in, confirmation email, unengaged filter, archived.
9 argumentů
idstringpovinnýAudience ID.namestringvisibility"public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.public_namestringName shown to subscribers instead of the internal name.public_descriptionstringShort description shown on the manage subscriptions page.double_opt_inobjectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.confirmation_emailobjectEmail sent after someone subscribes or confirms.unengagedobjectarchivedboolean
merge-audiencesÚpravafullCopy the subscribers of other audiences into this one. People already in it keep their status. Optionally delete the merged audiences.
3 argumenty
idstringpovinnýAudience to merge into.source_idsstring[]povinnýAudiences to merge into it.delete_sourcesbooleanDelete the merged audiences afterwards.
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.
10 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, subscribed_at, last_engaged_at, created_at.order"asc" | "desc"Sort direction.subscribedbooleanengagement"engaged" | "unengaged"Only subscribers with (or without) an open or click in the audience's unengaged window.
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.
7 argumentů
idstringpovinnýAudience ID.emailstringpovinnýfirst_namestringlast_namestringcustom_fieldsobjectdouble_opt_inbooleanSend the double opt-in email; they join when they confirm. The audience must have double opt-in on.send_confirmation_emailbooleanSend the audience confirmation email when it is on.
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.
bulk-update-audience-subscribersÚpravafullSubscribe or unsubscribe many subscribers of an audience: by subscriber ids, or every subscriber matching a filter (for example all unengaged ones).
7 argumentů
idstringpovinnýAudience ID.action"subscribe" | "unsubscribe"povinnýidsstring[]Subscriber ids.all_matchingbooleanApply to every subscriber matching engagement/subscribed/search instead of ids (up to 10,000).engagement"engaged" | "unengaged"subscribedbooleansearchstringMatch email or names, with all_matching.
bulk-remove-audience-subscribersSmazánífullRemove many subscribers from an audience by subscriber ids, or every subscriber matching a filter. Contacts are kept.
6 argumentů
idstringpovinnýAudience ID.idsstring[]Subscriber ids.all_matchingbooleanengagement"engaged" | "unengaged"subscribedbooleansearchstring
Kontakty contacts
create-contactVytvořenífullCreate a contact, optionally subscribing it to audiences and setting custom fields, tags and a lead score.
8 argumentů
emailstringpovinnýfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedbooleantagsstring[]Tags (stored lowercase).scorenumberInitial lead score.
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.
12 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, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedbooleantagstringOnly contacts with this tag (comma-separate several for any of them).min_scorenumberOnly contacts with at least this lead score.max_scorenumberOnly contacts with at most this lead score.
update-contactDestruktivnífullUpdate a contact. Passing audiences replaces its audience memberships, tags replaces its tags (add_tags / remove_tags change them), score sets the lead score, and unsubscribed: true stops all marketing email to it. Changes start "contact updated", "tag added" and "score changed" automations.
11 argumentů
idstringpovinnýContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedbooleantagsstring[]Replace all tags.add_tagsstring[]Tags (stored lowercase).remove_tagsstring[]Tags (stored lowercase).scorenumberSet the lead score.
add-contact-tagsÚpravafullAdd tags to a contact. Starts "tag added" automations and resumes automations waiting for the tag.
2 argumenty
idstringpovinnýContact ID (con_xxx) or email address.tagsstring[]povinnýTags (stored lowercase).
remove-contact-tagsÚpravafullRemove tags from a contact. Starts "tag removed" automations.
2 argumenty
idstringpovinnýContact ID (con_xxx) or email address.tagsstring[]povinnýTags (stored lowercase).
list-contact-tagsČtenífullList the tags used in the workspace with how many contacts have each.
2 argumenty
searchstringTag contains.limitnumber
update-contact-scoreAkcefullAdd to, subtract from or set a contact's lead score. Starts "score changed" automations (e.g. leads above 50 enter a sales workflow).
3 argumenty
idstringpovinnýContact ID (con_xxx) or email address.operation"add" | "subtract" | "set"Default add.valuenumberpovinný
delete-contactSmazánífullPermanently delete a contact and its audience memberships.
1 argument
idstringpovinnýContact ID (con_xxx) or email address.
bulk-delete-contactsSmazánífullPermanently delete up to 100 contacts and their audience memberships.
1 argument
idsstring[]povinnýContact IDs (con_xxx), up to 100.
bulk-add-contacts-to-audienceÚpravafullSubscribe up to 100 contacts to an audience.
2 argumenty
idsstring[]povinnýContact IDs (con_xxx), up to 100.audience_idstringpovinnýAudience ID (aud_xxx).
bulk-remove-contacts-from-audienceSmazánífullRemove up to 100 contacts from an audience.
2 argumenty
idsstring[]povinnýContact IDs (con_xxx), up to 100.audience_idstringpovinnýAudience ID (aud_xxx).
bulk-unsubscribe-contactsDestruktivnífullUnsubscribe up to 100 contacts from all marketing email. They stop receiving campaigns and automations.
1 argument
idsstring[]povinnýContact IDs (con_xxx), up to 100.
bulk-resubscribe-contactsÚpravafullResubscribe up to 100 contacts. Only do this when they asked to receive email again.
1 argument
idsstring[]povinnýContact IDs (con_xxx), up to 100.
export-contactsČtenífullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
12 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, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedbooleantagstringOnly contacts with this tag (comma-separate several for any of them).min_scorenumberOnly contacts with at least this lead score.max_scorenumberOnly contacts with at most this lead score.
Segmenty segments
list-segment-fieldsČtenífullAlfaList the fields, operators, and values that segment rules can use, including custom fields and audiences.
preview-segmentČtenífullAlfaCount and sample the contacts a segment definition would hold, without saving it.
3 argumenty
audience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.limitnumber
create-segmentVytvořenífullAlfaCreate a segment: a dynamic list of contacts from all contacts or chosen audiences, narrowed by filter rules. Campaigns can send to segments. Plans limit the number of segments (Pay as you go 3, Pro 10, Business 100).
5 argumentů
namestringpovinnýdescriptionstringaudience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.trackedbooleanPro and Business: store members so joins and leaves become events for automations and webhooks. Can't be changed after creation.
get-segmentČtenífullAlfaRetrieve a segment with its current contact counts.
1 argument
idstringpovinnýSegment ID (seg_xxx).
list-segmentsČtenífullAlfaList segments in the workspace.
8 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, updated_at.order"asc" | "desc"Sort direction.with_countsbooleanInclude contact counts (slower).
update-segmentDestruktivnífullAlfaUpdate a segment. Sending audience_ids or conditions replaces them; the previous values can't be restored.
5 argumentů
idstringpovinnýSegment ID (seg_xxx).namestringdescriptionstring | nullaudience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.
delete-segmentSmazánífullAlfaDelete a segment. Fails while a scheduled or sending campaign uses it; draft campaigns lose it.
1 argument
idstringpovinnýSegment ID (seg_xxx).
get-segment-growthČtenífullAlfaDaily members, joins and leaves of a tracked segment.
2 argumenty
idstringpovinnýSegment ID (seg_xxx).daysnumberDays to return, ending today (default 30).
list-segment-contactsČtenífullAlfaList the contacts currently in a segment. Tracked segments include when each contact joined.
8 argumentů
idstringpovinnýSegment ID (seg_xxx).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, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.
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-webhookExternífullCreate a webhook: Emailit will send email, domain, contact, and campaign events to this URL. The response includes the signing secret.
6 argumentů
namestringpovinnýurlstringpovinnýHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every system event type except the opt-in site-tracking events (product.viewed, cart.updated). Workspace (w:) and custom (c:) events are not included either; list them in events.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.held" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.resubscribed" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "segment.contact_added" | "segment.contact_removed" | "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" | "form.submitted" | "order.placed" | "order.updated" | "cart.updated" | "cart.abandoned" | "product.viewed" | string[]Event types to subscribe to. With all_events, list only what it leaves out: w:/c: types (or w:* / c:*) and opt-in site-tracking events.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-webhookExternífullUpdate a webhook URL, name, events, filter, or enable it again. Events then go to the new URL.
7 argumentů
idstringpovinnýWebhook ID (wh_xxx).namestringurlstringHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every system event type except the opt-in site-tracking events (product.viewed, cart.updated). Workspace (w:) and custom (c:) events are not included either; list them in events.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.held" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.resubscribed" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "segment.contact_added" | "segment.contact_removed" | "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" | "form.submitted" | "order.placed" | "order.updated" | "cart.updated" | "cart.abandoned" | "product.viewed" | string[]Event types to subscribe to. With all_events, list only what it leaves out: w:/c: types (or w:* / c:*) and opt-in site-tracking events.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.held" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.resubscribed" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "segment.contact_added" | "segment.contact_removed" | "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" | "form.submitted" | "order.placed" | "order.updated" | "cart.updated" | "cart.abandoned" | "product.viewed" | stringpovinnýEvent type to send, e.g. email.delivered or c:order.completed.
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-requestsExternífullSend every failed delivery of a webhook to its URL again and re-enable the webhook.
1 argument
idstringpovinnýWebhook ID (wh_xxx).
retry-webhook-requestExternífullSend one webhook delivery to its URL again.
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.
16 argumentů
namestringpovinnýsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body: HTML when content_type is html (the default), plain text when it is text.content_type"html" | "text"utm_trackingbooleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).utm_paramsobject | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.smart_sending_hoursnumber | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.exclude_unengagedbooleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.tagsstring[]Labels for filtering and the calendar (up to 20).track_loadsboolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).track_clicksboolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).ab_testobject | nullA/B test. Send { enabled: false } to turn it off.
update-campaignDestruktivnífullUpdate a draft campaign. Passing content replaces its body and passing recipients replaces the audience list (at least one audience must be included); the previous values can't be restored.
18 argumentů
idstringpovinnýCampaign ID (cmp_xxx) or name.namestringsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body: HTML when content_type is html (the default), plain text when it is text.content_type"html" | "text"utm_trackingbooleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).utm_paramsobject | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.smart_sending_hoursnumber | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.exclude_unengagedbooleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.tagsstring[]Labels for filtering and the calendar (up to 20).track_loadsboolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).track_clicksboolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).ab_testobject | nullA/B test. Send { enabled: false } to turn it off.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, optionally spread out (throttled, recipient local time, best time per contact). Delivers to real subscribers, so confirm with the user first.
4 argumenty
idstringpovinnýCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.send_strategy"immediate" | "throttled" | "local_time" | "smart_time"immediate (default); throttled: send_options.per_hour; local_time: send_options.local_time "YYYY-MM-DDTHH:mm" in each contact's time zone (send_options.timezone for the rest); smart_time: each contact at their usual engagement hour within send_options.window_hours (default 24).send_optionsobject
get-campaign-statsČtenífullResults of a sent campaign: delivered, opens, clicks, bounces, unsubscribes, mailbox providers, and A/B variant results with the leader and its significance.
1 argument
idstringpovinnýCampaign ID (cmp_xxx) or name.
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.
E-commerce: produkty, objednávky, košíky a kupony commerce
list-productsČtenífullAlfaList the product catalog used by product blocks ({{products ...}}), recommendations and order items.
5 argumentů
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringcategorystringstatus"active" | "archived" | "all"
get-productČtenífullAlfaRetrieve one product by Emailit id (prd_xxx) or your shop id.
1 argument
idstringpovinnýProduct ID (prd_xxx) or the id in your shop.
upsert-productÚpravafullAlfaCreate a product, or update it when the shop id exists. Only the fields sent are changed.
14 argumentů
idstring | numberpovinnýThe product id in your shop.titlestringskustringdescriptionstringurlstringimage_urlstringpricenumber | stringcompare_at_pricenumber | stringOriginal price; above price means on sale.currencystringISO 4217, e.g. EUR.categoriesstring[]brandstringinventory_quantitynumber | null0 hides it from recommendations; null = not tracked.status"active" | "archived"metadataobject
upsert-productsÚpravafullAlfaSync up to 1,000 products at once. Invalid ones are reported and skipped.
1 argument
productsobject[]povinný
delete-productSmazánífullAlfaDelete a product from the catalog. Orders keep their item details.
1 argument
idstringpovinnýProduct ID (prd_xxx) or the id in your shop.
list-ordersČtenífullAlfaList orders, optionally by contact, status, or the campaign or automation they are attributed to.
10 argumentů
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).contact_idstringemailstringstatus"placed" | "paid" | "fulfilled" | "canceled" | "refunded"campaign_idstringOrders attributed to this campaign.automation_idstringattributedbooleantrue: only orders credited to an email.fromstringtostring
get-orderČtenífullAlfaRetrieve an order with its items and attribution.
1 argument
idstringpovinnýOrder ID (ord_xxx) or the id in your shop.
upsert-orderÚpravafullAlfaRecord an order from your shop. New orders are credited to the campaign or automation email the buyer last clicked (or opened) and update the buyer's purchase metrics. Sending the same id again updates it.
20 argumentů
idstring | numberpovinnýThe order id in your shop. Sending the same id again updates the order.emailstringBuyer email. A new buyer becomes a contact unless create_contact is false.contact_idstringfirst_namestringlast_namestringstatus"placed" | "paid" | "fulfilled" | "canceled" | "refunded"currencystringISO 4217; defaults to the workspace commerce currency.subtotalnumber | stringdiscountnumber | stringshippingnumber | stringtaxnumber | stringtotalnumber | stringComputed from items when omitted.coupon_codesstring[]cart_idstringConverts the cart with this id.placed_atstringISO 8601; defaults to now.itemsobject[]create_contactbooleanaccepts_marketingbooleanWith audience_id: subscribe the buyer.audience_idstringmetadataobject
update-order-statusÚpravafullAlfaMark an order paid, fulfilled, canceled or refunded. Canceled orders stop counting as revenue; refunds are subtracted.
3 argumenty
idstringpovinnýOrder ID (ord_xxx) or the id in your shop.status"placed" | "paid" | "fulfilled" | "canceled" | "refunded"refunded_amountnumber | string
list-cartsČtenífullAlfaList shopping carts: active, abandoned (idle past the commerce settings delay) or converted.
4 argumenty
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"active" | "abandoned" | "converted"contact_idstring
upsert-cartÚpravafullAlfaRecord the buyer's current cart. Idle carts of known contacts become abandoned and emit cart.abandoned.
7 argumentů
idstring | numberpovinnýThe cart or checkout id in your shop.emailstringcontact_idstringcurrencystringtotalnumber | stringitemsobject[]checkout_urlstring
list-couponsČtenífullAlfaList coupons with how many codes are available, assigned and redeemed. Content uses them as {{coupon "key"}}.
3 argumenty
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstring
get-couponČtenífullAlfaRetrieve a coupon by id (cpn_xxx) or key.
1 argument
idstringpovinnýCoupon ID (cpn_xxx) or key.
create-couponVytvořenífullAlfaCreate a coupon. unique: a pool of single-use codes, one per recipient (add codes from your shop with add-coupon-codes); static: one code for everyone (static_code). static_code is also the fallback when a unique pool runs out.
7 argumentů
keystringpovinnýUsed in content as {{coupon "key"}}: lowercase letters, digits, "-" or "_".namestringpovinnýkind"unique" | "static"static_codestringdiscount_labelstringFor people, e.g. "20% off".expires_atstringcodesstring[]Initial codes for a unique coupon.
add-coupon-codesVytvořenífullAlfaAdd codes to a unique coupon, or generate random ones (then create the same codes in your shop). Duplicates are skipped.
3 argumenty
idstringpovinnýCoupon ID (cpn_xxx) or key.codesstring[]generateobject
get-commerce-settingsČtenífullAlfaCurrency, attribution windows (days after a click or an open) and the cart abandonment delay.
update-commerce-settingsÚpravafullAlfaRole AdminChange the commerce currency, attribution windows or cart abandonment delay. Attribution changes apply to new orders.
4 argumenty
currencystringattribution_click_daysnumberattribution_open_daysnumber0 credits clicks only.cart_abandon_minutesnumber
get-commerce-overviewČtenífullAlfaRevenue, revenue credited to campaigns and automations, new vs returning customers, carts, top products and top campaigns for a date range (default last 30 days).
2 argumenty
fromstringtostring
get-contact-commerceČtenífullAlfaA contact's purchase metrics (orders, spend, AOV, expected next order, churn risk), recent orders, open cart and recently viewed products.
1 argument
idstringpovinnýContact ID (con_xxx) or email.
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ífullSave a new automation as a draft: a trigger step, action steps, and connections between step keys. Saving runs nothing; steps run only after start-automation (for each matching event) or trigger-automation (one run). Each action does the same as one tool: send_email = send-email with a template, forward_email = forward-email, add_to_audience = add-audience-subscriber, remove_from_audience = remove-audience-subscriber, update_subscription = bulk-unsubscribe/resubscribe, edit_contact = update-contact, add_tag/remove_tag = add/remove-contact-tags, update_score = update-contact-score, create_contact = create-contact, add_to_suppressions = create-suppression, remove_from_suppressions = delete-suppression, exit_automation = remove-contact-from-automation. Steps that call webhooks can only be added in the dashboard or the REST API. Flow steps: wait, wait_until (date / event / condition, with timeout), condition, goal (runs jump to it when the contact meets it), experiment, run_automation (enter or move to another automation), end_run, end. settings.exit_conditions cancels a contact's run when an event or condition matches (e.g. a purchase). Plans: goal steps and custom events (contact.on_event in exits, goals and waits) need Pro or Business; the contact.on_event trigger needs Business (403 plan_required otherwise). Example "webinar": trigger contact.added_to_audience (registrants) -> wait_until date {type: "global", key: "webinar_date"} 1 day before -> send_email reminder -> wait_until date 1 hour before -> send_email; a goal on contact.on_event c:purchase -> add_tag customer -> exit_automation all -> run_automation onboarding; a separate automation on contact.score_changed threshold 50 starts the sales sequence.
6 argumentů
context"contact" | "email" | "event"povinnýWhat the automation runs on.namestringpovinnýdescriptionstring | nullsettingsobjectstepsobject[]povinnýconnectionsobject[]povinný
update-automationDestruktivnífullChange an automation's name, description or settings, or replace its steps and connections (same step types as create-automation). Passing steps or connections replaces the whole graph; the previous steps can't be restored.
6 argumentů
idstringpovinnýAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationSmazánífullDelete an automation. New events no longer start runs; runs already in progress finish.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
start-automationOdeslánífullStart or resume an automation. From then on every event that matches its trigger starts a run that executes its steps for real, including sending emails and changing contacts (see get-automation for the steps). Each run uses 3 credits.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
pause-automationAkcefullPause an automation so new events don't start runs. Runs already in progress keep going.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
stop-automationDestruktivnífullStop an automation and cancel every run in progress. Canceled runs can't be resumed, even if the automation is started again.
1 argument
idstringpovinnýAutomation ID (aut_xxx).
trigger-automationOdeslánífullStart one run of a running automation now. The run executes the automation's steps right away (see get-automation), including sending real emails. The automation needs a system.manual trigger step; in contact automations pass the contact as payload.contact_id.
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 or contact.
5 argumentů
idstringpovinnýAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"contact_idstringOnly runs of this contact (con_xxx).
get-automation-runČtenífullRetrieve one automation run with its step history.
2 argumenty
idstringpovinnýAutomation ID (aut_xxx).run_idstringpovinnýAutomation run ID.
cancel-automation-runDestruktivnífullCancel one running run: its waiting steps are canceled and no further steps run. Can't be undone.
3 argumenty
idstringpovinnýAutomation ID (aut_xxx).run_idstringpovinnýAutomation run ID (aur_xxx).reasonstring
remove-contact-from-automationDestruktivnífullCancel every running run of this automation for one contact (by contact_id or email), e.g. when they bought and must leave a sales sequence.
4 argumenty
idstringpovinnýAutomation ID (aut_xxx).contact_idstringContact ID (con_xxx).emailstringContact email, instead of contact_id.reasonstring
list-contact-automation-runsČtenífullList one contact's runs across all automations (latest 100), e.g. to see which workflows they are in.
3 argumenty
contact_idstringContact ID (con_xxx).emailstringContact email, instead of contact_id.status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
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.
Globální hodnoty global_values
list-global-valuesČtenífullList the workspace's global values: reusable values like a webinar date, booking link or offer URL, used as {{global.<key>}} in templates, automation steps and conditions.
get-global-valueČtenífullRetrieve one global value by ID or key.
1 argument
idstringpovinnýGlobal value ID (gv_xxx) or key.
create-global-valueVytvořenífullCreate a global value, used as {{global.<key>}}. Automations can wait until a date value ("1 day before global.webinar_date").
5 argumentů
keystringpovinnýLowercase letters, digits and _, starting with a letter.namestring | nulltype"text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.valuestring | number | boolean | nulldescriptionstring | null
update-global-valueÚpravafullChange a global value. Emails sent from then on use the new value, and so do runs that reach a Wait until step afterwards; runs already waiting keep the date they read.
6 argumentů
idstringpovinnýGlobal value ID (gv_xxx) or key.keystringnamestring | nulltype"text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.valuestring | number | boolean | nulldescriptionstring | null
delete-global-valueSmazánífullDelete a global value. Templates using it render it empty.
1 argument
idstringpovinnýGlobal value ID (gv_xxx) or key.
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-formExternífullPublish a form so it starts collecting signups from anyone with its link or embed.
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-emailExternífullCheck whether one address is deliverable. Result is safe, role, catch_all, unknown, inbox_full, disabled, disposable or invalid. Uses verification credits.
2 argumenty
emailstringpovinnýmode"fast" | "full"fast (default): syntax, domain and list checks only. full: also asks the mailbox server whether the address exists and whether the domain is catch-all.
create-verification-listVytvořenífullVerify up to 10,000 addresses in the background with the full mailbox check. Uses verification credits for each address; poll get-verification-list for progress and result counts.
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" | "role" | "catch_all" | "unknown" | "inbox_full" | "disabled" | "disposable" | "invalid"
Události events
list-eventsČtenífullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
5 argumentů
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).typestringEvent type or comma-separated types, e.g. "email.bounced,email.complained".scope"system" | "workspace" | "custom"Only system events, workspace-defined events (w:), or custom events (c:).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).
send-eventVytvořeníeventsRecord a workspace-defined event (type "w:<name>", validated against its definition) or a custom event (type "c:<name>", any JSON properties). Optionally attribute it to a contact by email or contact_id. Pro and Business plans (up to 100 / 1,000 event types); Pay as you go gets 403 plan_required.
5 argumentů
typestringpovinnýw:<name> or c:<name>, e.g. "c:order.completed".propertiesobjectEvent payload.emailstringContact email to attribute the event to.contact_idstringContact ID (con_xxx).occurred_atstringISO 8601 time it happened. Defaults to now.
list-workspace-eventsČtenífullList the workspace-defined event types (sent as w:<name>) with their typed properties.
3 argumenty
pagenumberPage number (default: 1).limitnumberResults per page (max: 250).searchstringMatch name or title.
get-workspace-eventČtenífullRetrieve one workspace event definition.
1 argument
idstringpovinnýDefinition ID (etp_xxx), name, or w:name.
create-workspace-eventVytvořenífullDefine a workspace event and its typed properties (string, number, date, boolean). Send it afterwards as w:<name>. Pro and Business plans.
4 argumenty
namestringpovinnýEvent name, e.g. "customer.type".titlestringdescriptionstringpropertiesobject[]
update-workspace-eventÚpravafullUpdate a workspace event definition. `properties`, when given, replaces the whole list. Stored events are not changed.
5 argumentů
idstringpovinnýDefinition ID (etp_xxx), name, or w:name.namestringtitlestringdescriptionstringpropertiesobject[]
delete-workspace-eventSmazánífullDelete a workspace event definition. Stored events are kept; new events of this type are rejected.
1 argument
idstringpovinnýDefinition ID (etp_xxx), name, or w:name.