Přejít na obsah
Dokumentace

Reference

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.

Aktualizováno 2. 10. 2026

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ísending

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

list-workspacesČtenísendingJen OAuth

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

switch-workspaceÚpravasendingJen OAuth

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

1 argument
  • workspace_id stringpovinnýWorkspace ID or exact name from list-workspaces.
create-workspaceVytvořenífullJen OAuth

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

1 argument
  • name stringpovinnýWorkspace name.

E-maily emails

send-emailOdeslánísending

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

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

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

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

Retrieve a single email with its status and delivery details.

1 argument
  • id stringpovinnýEmail ID (em_xxx).
get-email-rawČtenífull

Return the full raw MIME message of an email.

1 argument
  • id stringpovinnýEmail ID (em_xxx).
get-email-bodyČtenífull

Return the parsed text and HTML body of an email.

1 argument
  • id stringpovinnýEmail ID (em_xxx).
get-email-attachmentsČtenífull

Return the attachments of an email.

1 argument
  • id stringpovinnýEmail ID (em_xxx).
get-email-metaČtenífull

Return email metadata and headers without attachment content.

1 argument
  • id stringpovinnýEmail ID (em_xxx).
update-emailÚpravasending

Change the send time of a scheduled email.

2 argumenty
  • id stringpovinnýEmail ID (em_xxx).
  • scheduled_at stringpovinnýNew send time, ISO 8601.
cancel-emailDestruktivnísending

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

1 argument
  • id stringpovinnýEmail ID (em_xxx).
retry-emailOdeslánísending

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

1 argument
  • id stringpovinnýEmail ID (em_xxx).
forward-emailOdeslánísending

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

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

Domény domains

create-domainVytvořenífull

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

7 argumentů
  • name stringpovinnýDomain or subdomain, e.g. mail.acme.com.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
get-domainČtenífull

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

1 argument
  • id stringpovinnýDomain ID.
list-domainsČtenífull

List sending domains in the workspace.

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

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

9 argumentů
  • id stringpovinnýDomain ID.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
  • tracking_key string | nullCustom tracking CNAME label.
  • inbound_key string | null
delete-domainSmazánífullRole Admin

Permanently delete a domain. Sending from it stops immediately.

1 argument
  • id stringpovinnýDomain ID.
verify-domainAkcefull

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

1 argument
  • id stringpovinnýDomain ID.

DMARC dmarc

list-dmarc-reportsČtenífull

List DMARC aggregate or forensic reports received for a domain.

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

Retrieve one DMARC aggregate report with its records.

2 argumenty
  • id stringpovinnýDomain ID.
  • report_id stringpovinnýDMARC report ID.
list-dmarc-forensic-reportsČtenífull

List DMARC forensic (failure) reports for a domain.

5 argumentů
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportČtenífull

Retrieve one DMARC forensic report.

2 argumenty
  • id stringpovinnýDomain ID.
  • report_id stringpovinnýForensic report ID.
get-dmarc-statsČtenífull

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

3 argumenty
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesČtenífull

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

3 argumenty
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesČtenífull

DMARC message volume by sending country.

3 argumenty
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsČtenífull

DMARC message volume by sending network (ASN).

3 argumenty
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersČtenífull

Organizations that sent DMARC reports for the domain.

3 argumenty
  • id stringpovinnýDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportVytvořenífull

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

4 argumenty
  • id stringpovinnýDomain ID.
  • content stringRaw report XML.
  • content_base64 stringBase64 of the report file.
  • filename string

Šablony templates

create-templateVytvořenífull

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

8 argumentů
  • name stringpovinný
  • alias stringpovinnýUnique slug used by send-email.
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
get-templateČtenífull

Retrieve a template with its content.

1 argument
  • id stringpovinnýTemplate ID (tem_xxx).
list-templatesČtenífull

List templates in the workspace.

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

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

9 argumentů
  • id stringpovinnýTemplate ID (tem_xxx).
  • name string
  • alias string
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
delete-templateSmazánífull

Permanently delete a template.

1 argument
  • id stringpovinnýTemplate ID (tem_xxx).
publish-templateAkcefull

Publish the current template draft so new sends use it.

1 argument
  • id stringpovinnýTemplate ID (tem_xxx).

API klíče api_keys

create-api-keyVytvořenífullRole Admin

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

3 argumenty
  • name stringpovinný
  • scope "full" | "sending"sending = send-only, full = every endpoint.
  • sending_domain_id string | nullLock a sending key to one domain.
get-api-keyČtenífull

Retrieve an API key (without its secret).

1 argument
  • id stringpovinnýAPI key ID.
list-api-keysČtenífull

List API keys in the workspace.

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

Rename an API key.

2 argumenty
  • id stringpovinnýAPI key ID.
  • name stringpovinný
delete-api-keySmazánífullRole Admin

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

1 argument
  • id stringpovinnýAPI key ID.
regenerate-api-keyDestruktivnífullRole Admin

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

1 argument
  • id stringpovinnýAPI key ID.

Seznamy kontaktů a odběratelé audiences

create-audienceVytvořenífull

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

1 argument
  • name stringpovinný
get-audienceČtenífull

Retrieve an audience with subscriber counts.

1 argument
  • id stringpovinnýAudience ID.
list-audiencesČtenífull

List audiences in the workspace.

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

Rename an audience.

2 argumenty
  • id stringpovinnýAudience ID.
  • name stringpovinný
delete-audienceSmazánífull

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

1 argument
  • id stringpovinnýAudience ID.
list-audience-subscribersČtenífull

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

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

Retrieve one subscriber of an audience.

2 argumenty
  • id stringpovinnýAudience ID.
  • subscriber_id stringpovinnýSubscriber ID.
add-audience-subscriberVytvořenífull

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

5 argumentů
  • id stringpovinnýAudience ID.
  • email stringpovinný
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberÚpravafull

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

7 argumentů
  • id stringpovinnýAudience ID.
  • subscriber_id stringpovinnýSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberSmazánífull

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

2 argumenty
  • id stringpovinnýAudience ID.
  • subscriber_id stringpovinnýSubscriber ID.

Kontakty contacts

create-contactVytvořenífull

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

6 argumentů
  • email stringpovinný
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactČtenífull

Retrieve a contact by ID or email address.

1 argument
  • id stringpovinnýContact ID (con_xxx) or email address.
list-contactsČtenífull

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

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

Update a contact. Passing audiences replaces its audience memberships.

7 argumentů
  • id stringpovinnýContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactSmazánífull

Permanently delete a contact and its audience memberships.

1 argument
  • id stringpovinnýContact ID (con_xxx) or email address.
bulk-update-contactsDestruktivnífull

Apply 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ý
  • ids string[]povinnýContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsČtenífull

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

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

Blokované adresy suppressions

create-suppressionVytvořenífull

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

4 argumenty
  • email stringpovinný
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
get-suppressionČtenífull

Retrieve a suppression by ID or email address.

1 argument
  • id stringpovinnýSuppression ID (sup_xxx) or email address.
list-suppressionsČtenífull

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

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

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

4 argumenty
  • id stringpovinnýSuppression ID (sup_xxx) or email address.
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
delete-suppressionSmazánífull

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

1 argument
  • id stringpovinnýSuppression ID (sup_xxx) or email address.

Webhooky webhooks

create-webhookVytvořenífull

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

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

Retrieve a webhook with its subscribed events and filter.

1 argument
  • id stringpovinnýWebhook ID (wh_xxx).
list-webhooksČtenífull

List webhooks in the workspace.

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

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

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

Permanently delete a webhook. Pending deliveries are dropped.

1 argument
  • id stringpovinnýWebhook ID (wh_xxx).
test-webhookExternífull

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

2 argumenty
  • id stringpovinný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ífull

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

1 argument
  • id stringpovinnýWebhook ID (wh_xxx).
retry-failed-webhook-requestsAkcefull

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

1 argument
  • id stringpovinnýWebhook ID (wh_xxx).
retry-webhook-requestAkcefull

Queue one webhook delivery for retry.

2 argumenty
  • id stringpovinnýWebhook ID (wh_xxx).
  • request_id stringpovinnýWebhook request ID.

Kampaně campaigns

list-campaignsČtenífull

List marketing campaigns, optionally by status.

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

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

1 argument
  • id stringpovinnýCampaign ID (cmp_xxx) or name.
create-campaignVytvořenífull

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

8 argumentů
  • name stringpovinný
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
update-campaignÚpravafull

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

10 argumentů
  • id stringpovinnýCampaign ID (cmp_xxx) or name.
  • name string
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
  • recipients object[]
delete-campaignSmazánífull

Permanently delete a campaign that has not been sent.

1 argument
  • id stringpovinnýCampaign ID (cmp_xxx) or name.
send-campaignOdeslánífull

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

2 argumenty
  • id stringpovinnýCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDestruktivnífull

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

1 argument
  • id stringpovinnýCampaign ID (cmp_xxx) or name.

Automatizace automations

list-automationsČtenífull

List automations with context, status, and name filters.

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

Retrieve an automation with its steps and connections.

1 argument
  • id stringpovinnýAutomation ID (aut_xxx).
create-automationVytvořenífull

Create 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.
  • name stringpovinný
  • description string | null
  • settings object
  • steps object[]povinný
  • connections object[]povinný
update-automationÚpravafull

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

6 argumentů
  • id stringpovinnýAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationSmazánífull

Delete an automation and stop any runs in progress.

1 argument
  • id stringpovinnýAutomation ID (aut_xxx).
start-automationAkcefull

Start or resume an automation so new triggers enroll contacts.

1 argument
  • id stringpovinnýAutomation ID (aut_xxx).
pause-automationAkcefull

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

1 argument
  • id stringpovinnýAutomation ID (aut_xxx).
stop-automationAkcefull

Stop an automation and cancel runs in progress.

1 argument
  • id stringpovinnýAutomation ID (aut_xxx).
trigger-automationOdeslánífull

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

2 argumenty
  • id stringpovinnýAutomation ID (aut_xxx).
  • payload objectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsČtenífull

List runs of an automation, optionally by status.

4 argumenty
  • id stringpovinnýAutomation ID (aut_xxx).
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runČtenífull

Retrieve one automation run with its step history.

2 argumenty
  • id stringpovinnýAutomation ID (aut_xxx).
  • run_id stringpovinnýAutomation run ID.
get-automation-statsČtenífull

Return run totals by status and outcome for an automation.

3 argumenty
  • id stringpovinnýAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsČtenífull

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

4 argumenty
  • id stringpovinnýAutomation ID (aut_xxx).
  • step_key stringpovinnýStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Formuláře forms

list-formsČtenífull

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

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

Retrieve a signup form with its definition and settings.

1 argument
  • id stringpovinnýForm ID (frm_xxx).
create-formVytvořenífull

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

4 argumenty
  • name stringpovinný
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
update-formÚpravafull

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

5 argumentů
  • id stringpovinnýForm ID (frm_xxx).
  • name string
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
delete-formSmazánífull

Permanently delete a form. Embedded copies stop working.

1 argument
  • id stringpovinnýForm ID (frm_xxx).
publish-formAkcefull

Publish a form so it starts collecting signups.

1 argument
  • id stringpovinnýForm ID (frm_xxx).
unpublish-formAkcefull

Take a form offline. It stops collecting signups.

1 argument
  • id stringpovinnýForm ID (frm_xxx).
reset-form-tokenDestruktivnífull

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

1 argument
  • id stringpovinnýForm ID (frm_xxx).

Ověřování e-mailů verification

verify-emailVytvořenífull

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

2 argumenty
  • email stringpovinný
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listVytvořenífull

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

2 argumenty
  • name stringpovinný
  • emails string[]povinný
list-verification-listsČtenífull

List bulk verification lists with their progress.

4 argumenty
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • status "pending" | "processing" | "completed" | "failed" | "canceled"
  • search string
get-verification-listČtenífull

Retrieve a verification list with progress and result counts.

1 argument
  • id stringpovinnýVerification list ID (evl_xxx).
get-verification-list-resultsČtenífull

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

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

Události events

list-eventsČtenífull

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

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

Retrieve one event with its full payload.

1 argument
  • id stringpovinnýEvent ID (evt_xxx).

Byla tato stránka užitečná?

Děkujeme za zpětnou vazbu.

Děkujeme, čteme každou zprávu.