Skip to content
Docs

Reference

Every tool on the hosted Emailit MCP server, grouped by toolset, with its kind, required scope, role requirement and arguments.

Updated Oct 9, 2026

The hosted server at https://api.emailit.com/mcp exposes 135 tools in 16 toolsets, plus the segments and commerce toolsets and a few other alpha tools that only the Emailit team’s sessions list. This reference is generated from the server’s tool catalog, so it always matches what your assistant sees. Tool and argument descriptions are shown as the server sends them, in English.

Scope. Tools with scope sending also work with full. See Workspaces and permissions.

Kind. Read makes no changes. Create and update change data. Action changes state. Delete removes data. Destructive can’t be undone. External reaches systems outside Emailit, such as your webhook URL, DNS or mail servers. Send reaches real recipients. Kinds map to MCP tool annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint) so clients can ask before running write tools.

Workspace. With OAuth, every tool outside the Workspace toolset also takes an optional workspace argument (ID or exact name) to run that call in another allowed workspace. Tools marked Admin role are refused with admin_role_required for workspace Members. API key connections have no workspace argument and no role limits.

Results. Tools return JSON as text for every client and as structuredContent for clients that read structured results. List tools accept page, limit and structured filters ({ field, condition, value }).

Workspace workspace

get-current-workspaceReadsending

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-workspacesReadsendingOAuth only

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-workspaceUpdatesendingOAuth only

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 stringrequiredWorkspace ID or exact name from list-workspaces.
create-workspaceCreatefullOAuth only

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

1 argument
  • name stringrequiredWorkspace name, up to 100 characters.

Emails emails

send-emailSendsending

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 arguments
  • from stringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.
  • to string | string[]requiredRecipient 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-emailsReadfull

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

16 arguments
  • 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-emailReadfull

Retrieve a single email with its status and delivery details.

1 argument
  • id stringrequiredEmail ID (em_xxx).
get-email-rawReadfull

Return the full raw MIME message of an email.

1 argument
  • id stringrequiredEmail ID (em_xxx).
get-email-bodyReadfull

Return the parsed text and HTML body of an email.

1 argument
  • id stringrequiredEmail ID (em_xxx).
get-email-attachmentsReadfull

Return the attachments of an email.

1 argument
  • id stringrequiredEmail ID (em_xxx).
get-email-metaReadfull

Return email metadata and headers without attachment content.

1 argument
  • id stringrequiredEmail ID (em_xxx).
update-emailUpdatesending

Change the send time of a scheduled email.

2 arguments
  • id stringrequiredEmail ID (em_xxx).
  • scheduled_at stringrequiredNew send time, ISO 8601.
cancel-emailDestructivesending

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 stringrequiredEmail ID (em_xxx).
retry-emailSendsending

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

1 argument
  • id stringrequiredEmail ID (em_xxx).
forward-emailSendsending

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 arguments
  • id stringrequiredEmail ID (em_xxx).
  • to string | string[]requiredNew recipient email address(es).
  • include_headers booleanAdd forwarded headers and an optional comment. Default is a plain resend.
  • comment stringNote prepended when include_headers is true.
  • body stringAlias for comment.
  • html string
  • text string
  • from string
  • subject string

Domains domains

create-domainCreatefull

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

7 arguments
  • name stringrequiredDomain 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-domainReadfull

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

1 argument
  • id stringrequiredDomain ID.
list-domainsReadfull

List sending domains in the workspace.

7 arguments
  • 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-domainUpdatefull

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

9 arguments
  • id stringrequiredDomain 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-domainDeletefullAdmin role

Permanently delete a domain. Sending from it stops immediately.

1 argument
  • id stringrequiredDomain ID.
verify-domainExternalfull

Look up the domain's DNS records now and update the verification status of each record.

1 argument
  • id stringrequiredDomain ID.

DMARC dmarc

list-dmarc-reportsReadfull

List DMARC aggregate or forensic reports received for a domain.

11 arguments
  • id stringrequiredDomain 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-reportReadfull

Retrieve one DMARC aggregate report with its records.

2 arguments
  • id stringrequiredDomain ID.
  • report_id stringrequiredDMARC report ID.
list-dmarc-forensic-reportsReadfull

List DMARC forensic (failure) reports for a domain.

5 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportReadfull

Retrieve one DMARC forensic report.

2 arguments
  • id stringrequiredDomain ID.
  • report_id stringrequiredForensic report ID.
get-dmarc-statsReadfull

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

3 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesReadfull

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

3 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesReadfull

DMARC message volume by sending country.

3 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsReadfull

DMARC message volume by sending network (ASN).

3 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersReadfull

Organizations that sent DMARC reports for the domain.

3 arguments
  • id stringrequiredDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportCreatefull

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

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

Templates templates

create-templateCreatefull

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

8 arguments
  • name stringrequired
  • alias stringrequiredUnique 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-templateReadfull

Retrieve a template with its content.

1 argument
  • id stringrequiredTemplate ID (tem_xxx).
list-templatesReadfull

List templates in the workspace.

7 arguments
  • 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-templateUpdatefull

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

9 arguments
  • id stringrequiredTemplate 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-templateDeletefull

Permanently delete a template.

1 argument
  • id stringrequiredTemplate ID (tem_xxx).
publish-templateActionfull

Publish the current template draft so new sends use it.

1 argument
  • id stringrequiredTemplate ID (tem_xxx).
get-mjml-referenceReadfullAlpha

MJML 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-mjmlReadfullAlpha

Check 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
  • source stringrequiredMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.
render-mjmlReadfullAlpha

Compile 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 arguments
  • source stringrequiredMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.
  • variables objectTemple variables for rendered_html.

API keys api_keys

create-api-keyCreatefullAdmin role

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

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

Retrieve an API key (without its secret).

1 argument
  • id stringrequiredAPI key ID.
list-api-keysReadfull

List API keys in the workspace.

7 arguments
  • 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-keyUpdatefullAdmin role

Rename an API key.

2 arguments
  • id stringrequiredAPI key ID.
  • name stringrequired
delete-api-keyDeletefullAdmin role

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

1 argument
  • id stringrequiredAPI key ID.
regenerate-api-keyDestructivefullAdmin role

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

1 argument
  • id stringrequiredAPI key ID.

Audiences and subscribers audiences

create-audienceCreatefull

Create an audience (mailing list) for campaigns and automations, optionally with its settings.

7 arguments
  • name stringrequired
  • visibility "public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.
  • public_name stringName shown to subscribers instead of the internal name.
  • public_description stringShort description shown on the manage subscriptions page.
  • double_opt_in objectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.
  • confirmation_email objectEmail sent after someone subscribes or confirms.
  • unengaged object
get-audienceReadfull

Retrieve an audience with its settings, subscriber, unengaged and pending double opt-in counts.

1 argument
  • id stringrequiredAudience ID.
list-audiencesReadfull

List audiences in the workspace. Archived audiences are hidden unless archived is "true" or "all".

8 arguments
  • 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, public_name, visibility, subscribers_count, created_at.
  • order "asc" | "desc"Sort direction.
  • archived "true" | "false" | "all"
update-audienceUpdatefull

Rename an audience or change its settings: visibility, public name, double opt-in, confirmation email, unengaged filter, archived.

9 arguments
  • id stringrequiredAudience ID.
  • name string
  • visibility "public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.
  • public_name stringName shown to subscribers instead of the internal name.
  • public_description stringShort description shown on the manage subscriptions page.
  • double_opt_in objectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.
  • confirmation_email objectEmail sent after someone subscribes or confirms.
  • unengaged object
  • archived boolean
merge-audiencesUpdatefull

Copy the subscribers of other audiences into this one. People already in it keep their status. Optionally delete the merged audiences.

3 arguments
  • id stringrequiredAudience to merge into.
  • source_ids string[]requiredAudiences to merge into it.
  • delete_sources booleanDelete the merged audiences afterwards.
delete-audienceDeletefull

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

1 argument
  • id stringrequiredAudience ID.
list-audience-subscribersReadfull

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

10 arguments
  • id stringrequiredAudience 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, subscribed_at, last_engaged_at, created_at.
  • order "asc" | "desc"Sort direction.
  • subscribed boolean
  • engagement "engaged" | "unengaged"Only subscribers with (or without) an open or click in the audience's unengaged window.
get-audience-subscriberReadfull

Retrieve one subscriber of an audience.

2 arguments
  • id stringrequiredAudience ID.
  • subscriber_id stringrequiredSubscriber ID.
add-audience-subscriberCreatefull

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

7 arguments
  • id stringrequiredAudience ID.
  • email stringrequired
  • first_name string
  • last_name string
  • custom_fields object
  • double_opt_in booleanSend the double opt-in email; they join when they confirm. The audience must have double opt-in on.
  • send_confirmation_email booleanSend the audience confirmation email when it is on.
update-audience-subscriberUpdatefull

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

7 arguments
  • id stringrequiredAudience ID.
  • subscriber_id stringrequiredSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberDeletefull

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

2 arguments
  • id stringrequiredAudience ID.
  • subscriber_id stringrequiredSubscriber ID.
bulk-update-audience-subscribersUpdatefull

Subscribe or unsubscribe many subscribers of an audience: by subscriber ids, or every subscriber matching a filter (for example all unengaged ones).

7 arguments
  • id stringrequiredAudience ID.
  • action "subscribe" | "unsubscribe"required
  • ids string[]Subscriber ids.
  • all_matching booleanApply to every subscriber matching engagement/subscribed/search instead of ids (up to 10,000).
  • engagement "engaged" | "unengaged"
  • subscribed boolean
  • search stringMatch email or names, with all_matching.
bulk-remove-audience-subscribersDeletefull

Remove many subscribers from an audience by subscriber ids, or every subscriber matching a filter. Contacts are kept.

6 arguments
  • id stringrequiredAudience ID.
  • ids string[]Subscriber ids.
  • all_matching boolean
  • engagement "engaged" | "unengaged"
  • subscribed boolean
  • search string

Contacts contacts

create-contactCreatefull

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

8 arguments
  • email stringrequired
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
  • tags string[]Tags (stored lowercase).
  • score numberInitial lead score.
get-contactReadfull

Retrieve a contact by ID or email address.

1 argument
  • id stringrequiredContact ID (con_xxx) or email address.
list-contactsReadfull

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

12 arguments
  • 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, score, audience_id, custom_fields.<key>.
  • order "asc" | "desc"Sort direction.
  • audience_id stringOnly contacts in this audience.
  • unsubscribed boolean
  • tag stringOnly contacts with this tag (comma-separate several for any of them).
  • min_score numberOnly contacts with at least this lead score.
  • max_score numberOnly contacts with at most this lead score.
update-contactDestructivefull

Update 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 arguments
  • id stringrequiredContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
  • tags string[]Replace all tags.
  • add_tags string[]Tags (stored lowercase).
  • remove_tags string[]Tags (stored lowercase).
  • score numberSet the lead score.
add-contact-tagsUpdatefull

Add tags to a contact. Starts "tag added" automations and resumes automations waiting for the tag.

2 arguments
  • id stringrequiredContact ID (con_xxx) or email address.
  • tags string[]requiredTags (stored lowercase).
remove-contact-tagsUpdatefull

Remove tags from a contact. Starts "tag removed" automations.

2 arguments
  • id stringrequiredContact ID (con_xxx) or email address.
  • tags string[]requiredTags (stored lowercase).
list-contact-tagsReadfull

List the tags used in the workspace with how many contacts have each.

2 arguments
  • search stringTag contains.
  • limit number
update-contact-scoreActionfull

Add to, subtract from or set a contact's lead score. Starts "score changed" automations (e.g. leads above 50 enter a sales workflow).

3 arguments
  • id stringrequiredContact ID (con_xxx) or email address.
  • operation "add" | "subtract" | "set"Default add.
  • value numberrequired
delete-contactDeletefull

Permanently delete a contact and its audience memberships.

1 argument
  • id stringrequiredContact ID (con_xxx) or email address.
bulk-delete-contactsDeletefull

Permanently delete up to 100 contacts and their audience memberships.

1 argument
  • ids string[]requiredContact IDs (con_xxx), up to 100.
bulk-add-contacts-to-audienceUpdatefull

Subscribe up to 100 contacts to an audience.

2 arguments
  • ids string[]requiredContact IDs (con_xxx), up to 100.
  • audience_id stringrequiredAudience ID (aud_xxx).
bulk-remove-contacts-from-audienceDeletefull

Remove up to 100 contacts from an audience.

2 arguments
  • ids string[]requiredContact IDs (con_xxx), up to 100.
  • audience_id stringrequiredAudience ID (aud_xxx).
bulk-unsubscribe-contactsDestructivefull

Unsubscribe up to 100 contacts from all marketing email. They stop receiving campaigns and automations.

1 argument
  • ids string[]requiredContact IDs (con_xxx), up to 100.
bulk-resubscribe-contactsUpdatefull

Resubscribe up to 100 contacts. Only do this when they asked to receive email again.

1 argument
  • ids string[]requiredContact IDs (con_xxx), up to 100.
export-contactsReadfull

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

12 arguments
  • 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, score, audience_id, custom_fields.<key>.
  • order "asc" | "desc"Sort direction.
  • audience_id stringOnly contacts in this audience.
  • unsubscribed boolean
  • tag stringOnly contacts with this tag (comma-separate several for any of them).
  • min_score numberOnly contacts with at least this lead score.
  • max_score numberOnly contacts with at most this lead score.

Segments segments

list-segment-fieldsReadfullAlpha

List the fields, operators, and values that segment rules can use, including custom fields and audiences.

preview-segmentReadfullAlpha

Count and sample the contacts a segment definition would hold, without saving it.

3 arguments
  • audience_ids string[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.
  • conditions objectSegment filters. Omit for every contact in the source.
  • limit number
create-segmentCreatefullAlpha

Create 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 arguments
  • name stringrequired
  • description string
  • audience_ids string[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.
  • conditions objectSegment filters. Omit for every contact in the source.
  • tracked booleanPro and Business: store members so joins and leaves become events for automations and webhooks. Can't be changed after creation.
get-segmentReadfullAlpha

Retrieve a segment with its current contact counts.

1 argument
  • id stringrequiredSegment ID (seg_xxx).
list-segmentsReadfullAlpha

List segments in the workspace.

8 arguments
  • 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, updated_at.
  • order "asc" | "desc"Sort direction.
  • with_counts booleanInclude contact counts (slower).
update-segmentDestructivefullAlpha

Update a segment. Sending audience_ids or conditions replaces them; the previous values can't be restored.

5 arguments
  • id stringrequiredSegment ID (seg_xxx).
  • name string
  • description string | null
  • audience_ids string[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.
  • conditions objectSegment filters. Omit for every contact in the source.
delete-segmentDeletefullAlpha

Delete a segment. Fails while a scheduled or sending campaign uses it; draft campaigns lose it.

1 argument
  • id stringrequiredSegment ID (seg_xxx).
get-segment-growthReadfullAlpha

Daily members, joins and leaves of a tracked segment.

2 arguments
  • id stringrequiredSegment ID (seg_xxx).
  • days numberDays to return, ending today (default 30).
list-segment-contactsReadfullAlpha

List the contacts currently in a segment. Tracked segments include when each contact joined.

8 arguments
  • id stringrequiredSegment ID (seg_xxx).
  • 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, score, audience_id, custom_fields.<key>.
  • order "asc" | "desc"Sort direction.

Suppressions suppressions

create-suppressionCreatefull

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

4 arguments
  • email stringrequired
  • 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-suppressionReadfull

Retrieve a suppression by ID or email address.

1 argument
  • id stringrequiredSuppression ID (sup_xxx) or email address.
list-suppressionsReadfull

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

7 arguments
  • 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-suppressionUpdatefull

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

4 arguments
  • id stringrequiredSuppression 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-suppressionDeletefull

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

1 argument
  • id stringrequiredSuppression ID (sup_xxx) or email address.

Webhooks webhooks

create-webhookExternalfull

Create a webhook: Emailit will send email, domain, contact, and campaign events to this URL. The response includes the signing secret.

6 arguments
  • name stringrequired
  • url stringrequiredHTTPS endpoint that receives event POSTs.
  • all_events booleanSubscribe 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.
  • 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.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.
  • filter object | nullOnly deliver events matching these rules. Null clears the filter.
get-webhookReadfull

Retrieve a webhook with its subscribed events and filter.

1 argument
  • id stringrequiredWebhook ID (wh_xxx).
list-webhooksReadfull

List webhooks in the workspace.

7 arguments
  • 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-webhookExternalfull

Update a webhook URL, name, events, filter, or enable it again. Events then go to the new URL.

7 arguments
  • id stringrequiredWebhook ID (wh_xxx).
  • name string
  • url stringHTTPS endpoint that receives event POSTs.
  • all_events booleanSubscribe 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.
  • 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.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.
  • filter object | nullOnly deliver events matching these rules. Null clears the filter.
delete-webhookDeletefull

Permanently delete a webhook. Pending deliveries are dropped.

1 argument
  • id stringrequiredWebhook ID (wh_xxx).
test-webhookExternalfull

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

2 arguments
  • id stringrequiredWebhook 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" | stringrequiredEvent type to send, e.g. email.delivered or c:order.completed.
reset-webhook-secretDestructivefull

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

1 argument
  • id stringrequiredWebhook ID (wh_xxx).
retry-failed-webhook-requestsExternalfull

Send every failed delivery of a webhook to its URL again and re-enable the webhook.

1 argument
  • id stringrequiredWebhook ID (wh_xxx).
retry-webhook-requestExternalfull

Send one webhook delivery to its URL again.

2 arguments
  • id stringrequiredWebhook ID (wh_xxx).
  • request_id stringrequiredWebhook request ID.

Campaigns campaigns

list-campaignsReadfull

List marketing campaigns, optionally by status.

4 arguments
  • 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-campaignReadfull

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

1 argument
  • id stringrequiredCampaign ID (cmp_xxx) or name.
create-campaignCreatefull

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

16 arguments
  • name stringrequired
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body: HTML when content_type is html (the default), plain text when it is text.
  • content_type "html" | "text"
  • utm_tracking booleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).
  • utm_params object | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.
  • smart_sending_hours number | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.
  • exclude_unengaged booleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.
  • tags string[]Labels for filtering and the calendar (up to 20).
  • track_loads boolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).
  • track_clicks boolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).
  • ab_test object | nullA/B test. Send { enabled: false } to turn it off.
update-campaignDestructivefull

Update 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 arguments
  • id stringrequiredCampaign 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: HTML when content_type is html (the default), plain text when it is text.
  • content_type "html" | "text"
  • utm_tracking booleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).
  • utm_params object | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.
  • smart_sending_hours number | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.
  • exclude_unengaged booleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.
  • tags string[]Labels for filtering and the calendar (up to 20).
  • track_loads boolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).
  • track_clicks boolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).
  • ab_test object | nullA/B test. Send { enabled: false } to turn it off.
  • recipients object[]
delete-campaignDeletefull

Permanently delete a campaign that has not been sent.

1 argument
  • id stringrequiredCampaign ID (cmp_xxx) or name.
send-campaignSendfull

Send 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 arguments
  • id stringrequiredCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture 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_options object
get-campaign-statsReadfull

Results of a sent campaign: delivered, opens, clicks, bounces, unsubscribes, mailbox providers, and A/B variant results with the leader and its significance.

1 argument
  • id stringrequiredCampaign ID (cmp_xxx) or name.
cancel-campaignDestructivefull

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 stringrequiredCampaign ID (cmp_xxx) or name.

Commerce: products, orders, carts and coupons commerce

list-productsReadfullAlpha

List the product catalog used by product blocks ({{products ...}}), recommendations and order items.

5 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search string
  • category string
  • status "active" | "archived" | "all"
get-productReadfullAlpha

Retrieve one product by Emailit id (prd_xxx) or your shop id.

1 argument
  • id stringrequiredProduct ID (prd_xxx) or the id in your shop.
upsert-productUpdatefullAlpha

Create a product, or update it when the shop id exists. Only the fields sent are changed.

14 arguments
  • id string | numberrequiredThe product id in your shop.
  • title string
  • sku string
  • description string
  • url string
  • image_url string
  • price number | string
  • compare_at_price number | stringOriginal price; above price means on sale.
  • currency stringISO 4217, e.g. EUR.
  • categories string[]
  • brand string
  • inventory_quantity number | null0 hides it from recommendations; null = not tracked.
  • status "active" | "archived"
  • metadata object
upsert-productsUpdatefullAlpha

Sync up to 1,000 products at once. Invalid ones are reported and skipped.

1 argument
  • products object[]required
delete-productDeletefullAlpha

Delete a product from the catalog. Orders keep their item details.

1 argument
  • id stringrequiredProduct ID (prd_xxx) or the id in your shop.
list-ordersReadfullAlpha

List orders, optionally by contact, status, or the campaign or automation they are attributed to.

10 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • contact_id string
  • email string
  • status "placed" | "paid" | "fulfilled" | "canceled" | "refunded"
  • campaign_id stringOrders attributed to this campaign.
  • automation_id string
  • attributed booleantrue: only orders credited to an email.
  • from string
  • to string
get-orderReadfullAlpha

Retrieve an order with its items and attribution.

1 argument
  • id stringrequiredOrder ID (ord_xxx) or the id in your shop.
upsert-orderUpdatefullAlpha

Record 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 arguments
  • id string | numberrequiredThe order id in your shop. Sending the same id again updates the order.
  • email stringBuyer email. A new buyer becomes a contact unless create_contact is false.
  • contact_id string
  • first_name string
  • last_name string
  • status "placed" | "paid" | "fulfilled" | "canceled" | "refunded"
  • currency stringISO 4217; defaults to the workspace commerce currency.
  • subtotal number | string
  • discount number | string
  • shipping number | string
  • tax number | string
  • total number | stringComputed from items when omitted.
  • coupon_codes string[]
  • cart_id stringConverts the cart with this id.
  • placed_at stringISO 8601; defaults to now.
  • items object[]
  • create_contact boolean
  • accepts_marketing booleanWith audience_id: subscribe the buyer.
  • audience_id string
  • metadata object
update-order-statusUpdatefullAlpha

Mark an order paid, fulfilled, canceled or refunded. Canceled orders stop counting as revenue; refunds are subtracted.

3 arguments
  • id stringrequiredOrder ID (ord_xxx) or the id in your shop.
  • status "placed" | "paid" | "fulfilled" | "canceled" | "refunded"
  • refunded_amount number | string
list-cartsReadfullAlpha

List shopping carts: active, abandoned (idle past the commerce settings delay) or converted.

4 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • status "active" | "abandoned" | "converted"
  • contact_id string
upsert-cartUpdatefullAlpha

Record the buyer's current cart. Idle carts of known contacts become abandoned and emit cart.abandoned.

7 arguments
  • id string | numberrequiredThe cart or checkout id in your shop.
  • email string
  • contact_id string
  • currency string
  • total number | string
  • items object[]
  • checkout_url string
list-couponsReadfullAlpha

List coupons with how many codes are available, assigned and redeemed. Content uses them as {{coupon "key"}}.

3 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • search string
get-couponReadfullAlpha

Retrieve a coupon by id (cpn_xxx) or key.

1 argument
  • id stringrequiredCoupon ID (cpn_xxx) or key.
create-couponCreatefullAlpha

Create 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 arguments
  • key stringrequiredUsed in content as {{coupon "key"}}: lowercase letters, digits, "-" or "_".
  • name stringrequired
  • kind "unique" | "static"
  • static_code string
  • discount_label stringFor people, e.g. "20% off".
  • expires_at string
  • codes string[]Initial codes for a unique coupon.
add-coupon-codesCreatefullAlpha

Add codes to a unique coupon, or generate random ones (then create the same codes in your shop). Duplicates are skipped.

3 arguments
  • id stringrequiredCoupon ID (cpn_xxx) or key.
  • codes string[]
  • generate object
get-commerce-settingsReadfullAlpha

Currency, attribution windows (days after a click or an open) and the cart abandonment delay.

update-commerce-settingsUpdatefullAlphaAdmin role

Change the commerce currency, attribution windows or cart abandonment delay. Attribution changes apply to new orders.

4 arguments
  • currency string
  • attribution_click_days number
  • attribution_open_days number0 credits clicks only.
  • cart_abandon_minutes number
get-commerce-overviewReadfullAlpha

Revenue, 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 arguments
  • from string
  • to string
get-contact-commerceReadfullAlpha

A contact's purchase metrics (orders, spend, AOV, expected next order, churn risk), recent orders, open cart and recently viewed products.

1 argument
  • id stringrequiredContact ID (con_xxx) or email.

Automations automations

list-automationsReadfull

List automations with context, status, and name filters.

7 arguments
  • 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-automationReadfull

Retrieve an automation with its steps and connections.

1 argument
  • id stringrequiredAutomation ID (aut_xxx).
create-automationCreatefull

Save 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 arguments
  • context "contact" | "email" | "event"requiredWhat the automation runs on.
  • name stringrequired
  • description string | null
  • settings object
  • steps object[]required
  • connections object[]required
update-automationDestructivefull

Change 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 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationDeletefull

Delete an automation. New events no longer start runs; runs already in progress finish.

1 argument
  • id stringrequiredAutomation ID (aut_xxx).
start-automationSendfull

Start 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
  • id stringrequiredAutomation ID (aut_xxx).
pause-automationActionfull

Pause an automation so new events don't start runs. Runs already in progress keep going.

1 argument
  • id stringrequiredAutomation ID (aut_xxx).
stop-automationDestructivefull

Stop an automation and cancel every run in progress. Canceled runs can't be resumed, even if the automation is started again.

1 argument
  • id stringrequiredAutomation ID (aut_xxx).
trigger-automationSendfull

Start 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 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • payload objectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsReadfull

List runs of an automation, optionally by status or contact.

5 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
  • contact_id stringOnly runs of this contact (con_xxx).
get-automation-runReadfull

Retrieve one automation run with its step history.

2 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • run_id stringrequiredAutomation run ID.
cancel-automation-runDestructivefull

Cancel one running run: its waiting steps are canceled and no further steps run. Can't be undone.

3 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • run_id stringrequiredAutomation run ID (aur_xxx).
  • reason string
remove-contact-from-automationDestructivefull

Cancel 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 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • contact_id stringContact ID (con_xxx).
  • email stringContact email, instead of contact_id.
  • reason string
list-contact-automation-runsReadfull

List one contact's runs across all automations (latest 100), e.g. to see which workflows they are in.

3 arguments
  • contact_id stringContact ID (con_xxx).
  • email stringContact email, instead of contact_id.
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-statsReadfull

Return run totals by status and outcome for an automation.

3 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsReadfull

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

4 arguments
  • id stringrequiredAutomation ID (aut_xxx).
  • step_key stringrequiredStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Global values global_values

list-global-valuesReadfull

List 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-valueReadfull

Retrieve one global value by ID or key.

1 argument
  • id stringrequiredGlobal value ID (gv_xxx) or key.
create-global-valueCreatefull

Create a global value, used as {{global.<key>}}. Automations can wait until a date value ("1 day before global.webinar_date").

5 arguments
  • key stringrequiredLowercase letters, digits and _, starting with a letter.
  • name string | null
  • type "text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.
  • value string | number | boolean | null
  • description string | null
update-global-valueUpdatefull

Change 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 arguments
  • id stringrequiredGlobal value ID (gv_xxx) or key.
  • key string
  • name string | null
  • type "text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.
  • value string | number | boolean | null
  • description string | null
delete-global-valueDeletefull

Delete a global value. Templates using it render it empty.

1 argument
  • id stringrequiredGlobal value ID (gv_xxx) or key.

Forms forms

list-formsReadfull

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

7 arguments
  • 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-formReadfull

Retrieve a signup form with its definition and settings.

1 argument
  • id stringrequiredForm ID (frm_xxx).
create-formCreatefull

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

4 arguments
  • name stringrequired
  • 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-formUpdatefull

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

5 arguments
  • id stringrequiredForm 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-formDeletefull

Permanently delete a form. Embedded copies stop working.

1 argument
  • id stringrequiredForm ID (frm_xxx).
publish-formExternalfull

Publish a form so it starts collecting signups from anyone with its link or embed.

1 argument
  • id stringrequiredForm ID (frm_xxx).
unpublish-formActionfull

Take a form offline. It stops collecting signups.

1 argument
  • id stringrequiredForm ID (frm_xxx).
reset-form-tokenDestructivefull

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

1 argument
  • id stringrequiredForm ID (frm_xxx).

Email verification verification

verify-emailExternalfull

Check whether one address is deliverable. Result is safe, role, catch_all, unknown, inbox_full, disabled, disposable or invalid. Uses verification credits.

2 arguments
  • email stringrequired
  • 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-listCreatefull

Verify 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 arguments
  • name stringrequired
  • emails string[]required
list-verification-listsReadfull

List bulk verification lists with their progress.

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

Retrieve a verification list with progress and result counts.

1 argument
  • id stringrequiredVerification list ID (evl_xxx).
get-verification-list-resultsReadfull

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

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

Events events

list-eventsReadfull

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

5 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 100).
  • type stringEvent 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_data booleanInclude the full event payload. Default false.
get-eventReadfull

Retrieve one event with its full payload.

1 argument
  • id stringrequiredEvent ID (evt_xxx).
send-eventCreateevents

Record 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 arguments
  • type stringrequiredw:<name> or c:<name>, e.g. "c:order.completed".
  • properties objectEvent payload.
  • email stringContact email to attribute the event to.
  • contact_id stringContact ID (con_xxx).
  • occurred_at stringISO 8601 time it happened. Defaults to now.
list-workspace-eventsReadfull

List the workspace-defined event types (sent as w:<name>) with their typed properties.

3 arguments
  • page numberPage number (default: 1).
  • limit numberResults per page (max: 250).
  • search stringMatch name or title.
get-workspace-eventReadfull

Retrieve one workspace event definition.

1 argument
  • id stringrequiredDefinition ID (etp_xxx), name, or w:name.
create-workspace-eventCreatefull

Define a workspace event and its typed properties (string, number, date, boolean). Send it afterwards as w:<name>. Pro and Business plans.

4 arguments
  • name stringrequiredEvent name, e.g. "customer.type".
  • title string
  • description string
  • properties object[]
update-workspace-eventUpdatefull

Update a workspace event definition. `properties`, when given, replaces the whole list. Stored events are not changed.

5 arguments
  • id stringrequiredDefinition ID (etp_xxx), name, or w:name.
  • name string
  • title string
  • description string
  • properties object[]
delete-workspace-eventDeletefull

Delete a workspace event definition. Stored events are kept; new events of this type are rejected.

1 argument
  • id stringrequiredDefinition ID (etp_xxx), name, or w:name.

Was this page helpful?

Thanks for the feedback.

Thanks, we read every message.