Riferimento
Riferimento degli strumenti MCP
Tutti gli strumenti del server MCP ospitato di Emailit, raggruppati per toolset, con tipo, permesso richiesto, requisito di ruolo e argomenti.
Il server ospitato su https://api.emailit.com/mcp espone 135 strumenti in 16 toolset (gruppi di strumenti), più i toolset segments e commerce e alcuni altri strumenti alpha, elencati solo nelle sessioni del team di Emailit. Questo riferimento viene generato dal catalogo degli strumenti del server, quindi corrisponde sempre a ciò che vede il tuo assistente. Le descrizioni degli strumenti e degli argomenti sono mostrate come le invia il server, in inglese.
Permesso. Gli strumenti con permesso (scope) sending funzionano anche con full. Vedi Workspace e permessi.
Tipo. Lettura non apporta modifiche. Creazione e Modifica cambiano i dati. Azione cambia uno stato. Eliminazione rimuove dati. Distruttivo non si può annullare. Esterno contatta sistemi al di fuori di Emailit, come l’URL del tuo webhook, il DNS o i server di posta. Invio raggiunge destinatari reali. I tipi corrispondono alle annotazioni degli strumenti MCP (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), così i client possono chiedere conferma prima di eseguire strumenti di scrittura.
Workspace. Con OAuth, ogni strumento esterno al toolset Workspace accetta anche un argomento facoltativo workspace (ID o nome esatto) per eseguire quella chiamata in un altro workspace consentito. Gli strumenti contrassegnati con Ruolo Admin vengono rifiutati con admin_role_required per i membri con ruolo Member. Le connessioni con chiave API non hanno l’argomento workspace né limiti di ruolo.
Risultati. Gli strumenti restituiscono JSON come testo per tutti i client e come structuredContent per i client che leggono risultati strutturati. Gli strumenti di elenco accettano page, limit e filtri strutturati ({ field, condition, value }).
Workspace workspace
get-current-workspaceLetturasendingReturn 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-workspacesLetturasendingSolo OAuthList the workspaces this connection may use, with your role in each. Pass a workspace ID or name as `workspace` to any tool to act in it.
switch-workspaceModificasendingSolo OAuthChange the default workspace for later tool calls on this connection. To act in another workspace for a single call, pass `workspace` to that tool instead.
1 argomento
workspace_idstringobbligatorioWorkspace ID or exact name from list-workspaces.
create-workspaceCreazionefullSolo OAuthCreate a new workspace, give this connection access to it, and switch to it.
1 argomento
namestringobbligatorioWorkspace name, up to 100 characters.
Email emails
send-emailInviosendingSend 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 argomenti
fromstringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.tostring | string[]obbligatorioRecipient email address(es).subjectstringSubject line. Optional when a template provides it.htmlstringHTML body.textstringPlain-text body.reply_tostring | string[]ccstring | string[]bccstring | string[]templatestringTemplate ID (tem_xxx) or alias.variablesobjectTemplate variables.attachmentsobject[]headersobjectmetaobjectCustom metadata returned in events and webhooks.scheduled_atstringISO 8601 time or natural language like "tomorrow at 9am".trackingboolean | object
list-emailsLetturafullList sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.
16 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: to, from, subject, status, tag, created_at, updated_at, spam_score, api_key_id, sending_domain_id.order"asc" | "desc"Sort direction.type"inbound" | "outbound"status"accepted" | "scheduled" | "clicked" | "loaded" | "delivered" | "bounced" | "attempted" | "failed" | "rejected" | "suppressed" | "received" | "complained" | "canceled" | "held"rcpt_tostringRecipient address contains.mail_fromstringSender address contains.subjectstringSubject contains.api_key_idstringsending_domain_idstringdate_fromstringISO date, inclusive.date_tostringISO date, inclusive.
get-emailLetturafullRetrieve a single email with its status and delivery details.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
get-email-rawLetturafullReturn the full raw MIME message of an email.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
get-email-bodyLetturafullReturn the parsed text and HTML body of an email.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
get-email-attachmentsLetturafullReturn the attachments of an email.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
get-email-metaLetturafullReturn email metadata and headers without attachment content.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
update-emailModificasendingChange the send time of a scheduled email.
2 argomenti
idstringobbligatorioEmail ID (em_xxx).scheduled_atstringobbligatorioNew send time, ISO 8601.
cancel-emailDistruttivosendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
retry-emailInviosendingRetry delivery of a failed, errored, or held email to its original recipients.
1 argomento
idstringobbligatorioEmail ID (em_xxx).
forward-emailInviosendingForward 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 argomenti
idstringobbligatorioEmail ID (em_xxx).tostring | string[]obbligatorioNew recipient email address(es).include_headersbooleanAdd forwarded headers and an optional comment. Default is a plain resend.commentstringNote prepended when include_headers is true.bodystringAlias for comment.htmlstringtextstringfromstringsubjectstring
Domini domains
create-domainCreazionefullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 argomenti
namestringobbligatorioDomain or subdomain, e.g. mail.acme.com.outgoingbooleanAllow sending from this domain.incomingbooleanAccept inbound email for this domain.use_for_anybooleantrack_loadsbooleanTrack opens.track_clicksbooleanTrack link clicks.dmarc_reportsbooleanCollect DMARC aggregate reports.
get-domainLetturafullRetrieve a domain with its DNS records and per-record verification status.
1 argomento
idstringobbligatorioDomain ID.
list-domainsLetturafullList sending domains in the workspace.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, created_at, spf_status, dkim_status, return_path_status.order"asc" | "desc"Sort direction.
update-domainModificafullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 argomenti
idstringobbligatorioDomain ID.outgoingbooleanAllow sending from this domain.incomingbooleanAccept inbound email for this domain.use_for_anybooleantrack_loadsbooleanTrack opens.track_clicksbooleanTrack link clicks.dmarc_reportsbooleanCollect DMARC aggregate reports.tracking_keystring | nullCustom tracking CNAME label.inbound_keystring | null
delete-domainEliminazionefullRuolo AdminPermanently delete a domain. Sending from it stops immediately.
1 argomento
idstringobbligatorioDomain ID.
verify-domainEsternofullLook up the domain's DNS records now and update the verification status of each record.
1 argomento
idstringobbligatorioDomain ID.
DMARC dmarc
list-dmarc-reportsLetturafullList DMARC aggregate or forensic reports received for a domain.
11 argomenti
idstringobbligatorioDomain ID.pagenumberPage number (default: 1).limitnumberResults per page (max: 100).filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.type"aggregate" | "forensic"statusstringorg_namestringReporting organization, e.g. google.com.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.offsetnumber
get-dmarc-reportLetturafullRetrieve one DMARC aggregate report with its records.
2 argomenti
idstringobbligatorioDomain ID.report_idstringobbligatorioDMARC report ID.
list-dmarc-forensic-reportsLetturafullList DMARC forensic (failure) reports for a domain.
5 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportLetturafullRetrieve one DMARC forensic report.
2 argomenti
idstringobbligatorioDomain ID.report_idstringobbligatorioForensic report ID.
get-dmarc-statsLetturafullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesLetturafullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesLetturafullDMARC message volume by sending country.
3 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsLetturafullDMARC message volume by sending network (ASN).
3 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersLetturafullOrganizations that sent DMARC reports for the domain.
3 argomenti
idstringobbligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportCreazionefullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 argomenti
idstringobbligatorioDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Template templates
create-templateCreazionefullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 argomenti
namestringobbligatorioaliasstringobbligatorioUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateLetturafullRetrieve a template with its content.
1 argomento
idstringobbligatorioTemplate ID (tem_xxx).
list-templatesLetturafullList templates in the workspace.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, alias, editor, subject, created_at.order"asc" | "desc"Sort direction.include_contentbooleanInclude HTML and text bodies.
update-templateModificafullUpdate a template draft. Publish it to make the change live.
9 argomenti
idstringobbligatorioTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateEliminazionefullPermanently delete a template.
1 argomento
idstringobbligatorioTemplate ID (tem_xxx).
publish-templateAzionefullPublish the current template draft so new sends use it.
1 argomento
idstringobbligatorioTemplate ID (tem_xxx).
get-mjml-referenceLetturafullAlphaMJML 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-mjmlLetturafullAlphaCheck 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 argomento
sourcestringobbligatorioMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.
render-mjmlLetturafullAlphaCompile 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 argomenti
sourcestringobbligatorioMJML markup (<mjml>...</mjml>), MJML JSON, or a template's stored MJML source.variablesobjectTemple variables for rendered_html.
Chiavi API api_keys
create-api-keyCreazionefullRuolo AdminCreate an API key. The secret is returned only once; tell the user to store it securely.
3 argomenti
namestringobbligatorioscope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyLetturafullRetrieve an API key (without its secret).
1 argomento
idstringobbligatorioAPI key ID.
list-api-keysLetturafullList API keys in the workspace.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, type, scope, created_at.order"asc" | "desc"Sort direction.
update-api-keyModificafullRuolo AdminRename an API key.
2 argomenti
idstringobbligatorioAPI key ID.namestringobbligatorio
delete-api-keyEliminazionefullRuolo AdminPermanently revoke an API key. Apps using it stop working immediately.
1 argomento
idstringobbligatorioAPI key ID.
regenerate-api-keyDistruttivofullRuolo AdminIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 argomento
idstringobbligatorioAPI key ID.
Liste e iscritti audiences
create-audienceCreazionefullCreate an audience (mailing list) for campaigns and automations, optionally with its settings.
7 argomenti
namestringobbligatoriovisibility"public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.public_namestringName shown to subscribers instead of the internal name.public_descriptionstringShort description shown on the manage subscriptions page.double_opt_inobjectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.confirmation_emailobjectEmail sent after someone subscribes or confirms.unengagedobject
get-audienceLetturafullRetrieve an audience with its settings, subscriber, unengaged and pending double opt-in counts.
1 argomento
idstringobbligatorioAudience ID.
list-audiencesLetturafullList audiences in the workspace. Archived audiences are hidden unless archived is "true" or "all".
8 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, public_name, visibility, subscribers_count, created_at.order"asc" | "desc"Sort direction.archived"true" | "false" | "all"
update-audienceModificafullRename an audience or change its settings: visibility, public name, double opt-in, confirmation email, unengaged filter, archived.
9 argomenti
idstringobbligatorioAudience ID.namestringvisibility"public" | "private"public: listed on the manage subscriptions page for everyone. private: only for contacts already subscribed.public_namestringName shown to subscribers instead of the internal name.public_descriptionstringShort description shown on the manage subscriptions page.double_opt_inobjectAsk people who join through the subscribe URL, forms or the API (double_opt_in: true) to confirm by email.confirmation_emailobjectEmail sent after someone subscribes or confirms.unengagedobjectarchivedboolean
merge-audiencesModificafullCopy the subscribers of other audiences into this one. People already in it keep their status. Optionally delete the merged audiences.
3 argomenti
idstringobbligatorioAudience to merge into.source_idsstring[]obbligatorioAudiences to merge into it.delete_sourcesbooleanDelete the merged audiences afterwards.
delete-audienceEliminazionefullPermanently delete an audience and its subscriber records. Contacts are kept.
1 argomento
idstringobbligatorioAudience ID.
list-audience-subscribersLetturafullList subscribers of an audience, optionally only subscribed or unsubscribed.
10 argomenti
idstringobbligatorioAudience ID.pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, subscribed, subscribed_at, last_engaged_at, created_at.order"asc" | "desc"Sort direction.subscribedbooleanengagement"engaged" | "unengaged"Only subscribers with (or without) an open or click in the audience's unengaged window.
get-audience-subscriberLetturafullRetrieve one subscriber of an audience.
2 argomenti
idstringobbligatorioAudience ID.subscriber_idstringobbligatorioSubscriber ID.
add-audience-subscriberCreazionefullAdd an email address to an audience. Creates the contact if it does not exist.
7 argomenti
idstringobbligatorioAudience ID.emailstringobbligatoriofirst_namestringlast_namestringcustom_fieldsobjectdouble_opt_inbooleanSend the double opt-in email; they join when they confirm. The audience must have double opt-in on.send_confirmation_emailbooleanSend the audience confirmation email when it is on.
update-audience-subscriberModificafullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 argomenti
idstringobbligatorioAudience ID.subscriber_idstringobbligatorioSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberEliminazionefullRemove a subscriber from an audience. The contact is kept.
2 argomenti
idstringobbligatorioAudience ID.subscriber_idstringobbligatorioSubscriber ID.
bulk-update-audience-subscribersModificafullSubscribe or unsubscribe many subscribers of an audience: by subscriber ids, or every subscriber matching a filter (for example all unengaged ones).
7 argomenti
idstringobbligatorioAudience ID.action"subscribe" | "unsubscribe"obbligatorioidsstring[]Subscriber ids.all_matchingbooleanApply to every subscriber matching engagement/subscribed/search instead of ids (up to 10,000).engagement"engaged" | "unengaged"subscribedbooleansearchstringMatch email or names, with all_matching.
bulk-remove-audience-subscribersEliminazionefullRemove many subscribers from an audience by subscriber ids, or every subscriber matching a filter. Contacts are kept.
6 argomenti
idstringobbligatorioAudience ID.idsstring[]Subscriber ids.all_matchingbooleanengagement"engaged" | "unengaged"subscribedbooleansearchstring
Contatti contacts
create-contactCreazionefullCreate a contact, optionally subscribing it to audiences and setting custom fields, tags and a lead score.
8 argomenti
emailstringobbligatoriofirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedbooleantagsstring[]Tags (stored lowercase).scorenumberInitial lead score.
get-contactLetturafullRetrieve a contact by ID or email address.
1 argomento
idstringobbligatorioContact ID (con_xxx) or email address.
list-contactsLetturafullList contacts with search, audience, subscription, and custom-field filters.
12 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedbooleantagstringOnly contacts with this tag (comma-separate several for any of them).min_scorenumberOnly contacts with at least this lead score.max_scorenumberOnly contacts with at most this lead score.
update-contactDistruttivofullUpdate 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 argomenti
idstringobbligatorioContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedbooleantagsstring[]Replace all tags.add_tagsstring[]Tags (stored lowercase).remove_tagsstring[]Tags (stored lowercase).scorenumberSet the lead score.
add-contact-tagsModificafullAdd tags to a contact. Starts "tag added" automations and resumes automations waiting for the tag.
2 argomenti
idstringobbligatorioContact ID (con_xxx) or email address.tagsstring[]obbligatorioTags (stored lowercase).
remove-contact-tagsModificafullRemove tags from a contact. Starts "tag removed" automations.
2 argomenti
idstringobbligatorioContact ID (con_xxx) or email address.tagsstring[]obbligatorioTags (stored lowercase).
list-contact-tagsLetturafullList the tags used in the workspace with how many contacts have each.
2 argomenti
searchstringTag contains.limitnumber
update-contact-scoreAzionefullAdd to, subtract from or set a contact's lead score. Starts "score changed" automations (e.g. leads above 50 enter a sales workflow).
3 argomenti
idstringobbligatorioContact ID (con_xxx) or email address.operation"add" | "subtract" | "set"Default add.valuenumberobbligatorio
delete-contactEliminazionefullPermanently delete a contact and its audience memberships.
1 argomento
idstringobbligatorioContact ID (con_xxx) or email address.
bulk-delete-contactsEliminazionefullPermanently delete up to 100 contacts and their audience memberships.
1 argomento
idsstring[]obbligatorioContact IDs (con_xxx), up to 100.
bulk-add-contacts-to-audienceModificafullSubscribe up to 100 contacts to an audience.
2 argomenti
idsstring[]obbligatorioContact IDs (con_xxx), up to 100.audience_idstringobbligatorioAudience ID (aud_xxx).
bulk-remove-contacts-from-audienceEliminazionefullRemove up to 100 contacts from an audience.
2 argomenti
idsstring[]obbligatorioContact IDs (con_xxx), up to 100.audience_idstringobbligatorioAudience ID (aud_xxx).
bulk-unsubscribe-contactsDistruttivofullUnsubscribe up to 100 contacts from all marketing email. They stop receiving campaigns and automations.
1 argomento
idsstring[]obbligatorioContact IDs (con_xxx), up to 100.
bulk-resubscribe-contactsModificafullResubscribe up to 100 contacts. Only do this when they asked to receive email again.
1 argomento
idsstring[]obbligatorioContact IDs (con_xxx), up to 100.
export-contactsLetturafullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
12 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedbooleantagstringOnly contacts with this tag (comma-separate several for any of them).min_scorenumberOnly contacts with at least this lead score.max_scorenumberOnly contacts with at most this lead score.
Segmenti segments
list-segment-fieldsLetturafullAlphaList the fields, operators, and values that segment rules can use, including custom fields and audiences.
preview-segmentLetturafullAlphaCount and sample the contacts a segment definition would hold, without saving it.
3 argomenti
audience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.limitnumber
create-segmentCreazionefullAlphaCreate 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 argomenti
namestringobbligatoriodescriptionstringaudience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.trackedbooleanPro and Business: store members so joins and leaves become events for automations and webhooks. Can't be changed after creation.
get-segmentLetturafullAlphaRetrieve a segment with its current contact counts.
1 argomento
idstringobbligatorioSegment ID (seg_xxx).
list-segmentsLetturafullAlphaList segments in the workspace.
8 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, created_at, updated_at.order"asc" | "desc"Sort direction.with_countsbooleanInclude contact counts (slower).
update-segmentDistruttivofullAlphaUpdate a segment. Sending audience_ids or conditions replaces them; the previous values can't be restored.
5 argomenti
idstringobbligatorioSegment ID (seg_xxx).namestringdescriptionstring | nullaudience_idsstring[]Audience IDs (aud_xxx) the segment draws from. Empty or omitted means all contacts.conditionsobjectSegment filters. Omit for every contact in the source.
delete-segmentEliminazionefullAlphaDelete a segment. Fails while a scheduled or sending campaign uses it; draft campaigns lose it.
1 argomento
idstringobbligatorioSegment ID (seg_xxx).
get-segment-growthLetturafullAlphaDaily members, joins and leaves of a tracked segment.
2 argomenti
idstringobbligatorioSegment ID (seg_xxx).daysnumberDays to return, ending today (default 30).
list-segment-contactsLetturafullAlphaList the contacts currently in a segment. Tracked segments include when each contact joined.
8 argomenti
idstringobbligatorioSegment ID (seg_xxx).pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed, score, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.
Soppressioni suppressions
create-suppressionCreazionefullAdd an email address to the suppression list so Emailit never sends to it.
4 argomenti
emailstringobbligatoriotype"recipient" | "bounce" | "complaint" | "unsubscribe"reasonstringkeep_untilstring | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
get-suppressionLetturafullRetrieve a suppression by ID or email address.
1 argomento
idstringobbligatorioSuppression ID (sup_xxx) or email address.
list-suppressionsLetturafullList suppressed addresses with search, type, reason, and expiry filters.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: email, reason, type, created_at, keep_until.order"asc" | "desc"Sort direction.
update-suppressionModificafullChange the type, reason, or expiry of a suppression.
4 argomenti
idstringobbligatorioSuppression ID (sup_xxx) or email address.type"recipient" | "bounce" | "complaint" | "unsubscribe"reasonstringkeep_untilstring | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
delete-suppressionEliminazionefullRemove an address from the suppression list so it can receive email again.
1 argomento
idstringobbligatorioSuppression ID (sup_xxx) or email address.
Webhook webhooks
create-webhookEsternofullCreate a webhook: Emailit will send email, domain, contact, and campaign events to this URL. The response includes the signing secret.
6 argomenti
namestringobbligatoriourlstringobbligatorioHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every system event type except the opt-in site-tracking events (product.viewed, cart.updated). Workspace (w:) and custom (c:) events are not included either; list them in events.enabledbooleanevents"email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.held" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.resubscribed" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "segment.contact_added" | "segment.contact_removed" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived" | "form.submitted" | "order.placed" | "order.updated" | "cart.updated" | "cart.abandoned" | "product.viewed" | string[]Event types to subscribe to. With all_events, list only what it leaves out: w:/c: types (or w:* / c:*) and opt-in site-tracking events.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
get-webhookLetturafullRetrieve a webhook with its subscribed events and filter.
1 argomento
idstringobbligatorioWebhook ID (wh_xxx).
list-webhooksLetturafullList webhooks in the workspace.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, url, enabled, created_at.order"asc" | "desc"Sort direction.
update-webhookEsternofullUpdate a webhook URL, name, events, filter, or enable it again. Events then go to the new URL.
7 argomenti
idstringobbligatorioWebhook ID (wh_xxx).namestringurlstringHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every system event type except the opt-in site-tracking events (product.viewed, cart.updated). Workspace (w:) and custom (c:) events are not included either; list them in events.enabledbooleanevents"email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.held" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.resubscribed" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "segment.contact_added" | "segment.contact_removed" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived" | "form.submitted" | "order.placed" | "order.updated" | "cart.updated" | "cart.abandoned" | "product.viewed" | string[]Event types to subscribe to. With all_events, list only what it leaves out: w:/c: types (or w:* / c:*) and opt-in site-tracking events.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
delete-webhookEliminazionefullPermanently delete a webhook. Pending deliveries are dropped.
1 argomento
idstringobbligatorioWebhook ID (wh_xxx).
test-webhookEsternofullSend a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.
2 argomenti
idstringobbligatorioWebhook 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" | stringobbligatorioEvent type to send, e.g. email.delivered or c:order.completed.
reset-webhook-secretDistruttivofullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 argomento
idstringobbligatorioWebhook ID (wh_xxx).
retry-failed-webhook-requestsEsternofullSend every failed delivery of a webhook to its URL again and re-enable the webhook.
1 argomento
idstringobbligatorioWebhook ID (wh_xxx).
retry-webhook-requestEsternofullSend one webhook delivery to its URL again.
2 argomenti
idstringobbligatorioWebhook ID (wh_xxx).request_idstringobbligatorioWebhook request ID.
Campagne campaigns
list-campaignsLetturafullList marketing campaigns, optionally by status.
4 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringSearch by name or subject.status"all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignLetturafullRetrieve a campaign with its content, recipients, and stats.
1 argomento
idstringobbligatorioCampaign ID (cmp_xxx) or name.
create-campaignCreazionefullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
16 argomenti
namestringobbligatoriosubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body: HTML when content_type is html (the default), plain text when it is text.content_type"html" | "text"utm_trackingbooleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).utm_paramsobject | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.smart_sending_hoursnumber | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.exclude_unengagedbooleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.tagsstring[]Labels for filtering and the calendar (up to 20).track_loadsboolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).track_clicksboolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).ab_testobject | nullA/B test. Send { enabled: false } to turn it off.
update-campaignDistruttivofullUpdate 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 argomenti
idstringobbligatorioCampaign ID (cmp_xxx) or name.namestringsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body: HTML when content_type is html (the default), plain text when it is text.content_type"html" | "text"utm_trackingbooleanAdd UTM parameters to every link (default utm_source=emailit, utm_medium=email, utm_campaign=<campaign name>).utm_paramsobject | nullUTM overrides. Values may use {campaign_name}, {campaign_id}, {subject}, {variant}, {send_date}.smart_sending_hoursnumber | nullSkip contacts another campaign emailed within this many hours (16 is common). null turns it off.exclude_unengagedbooleanSkip contacts sent 3+ campaigns in 90 days without opening or clicking any.tagsstring[]Labels for filtering and the calendar (up to 20).track_loadsboolean | nullOverride the sending domain's open tracking for this campaign. null follows the domain (the default).track_clicksboolean | nullOverride the sending domain's click tracking for this campaign. null follows the domain (the default).ab_testobject | nullA/B test. Send { enabled: false } to turn it off.recipientsobject[]
delete-campaignEliminazionefullPermanently delete a campaign that has not been sent.
1 argomento
idstringobbligatorioCampaign ID (cmp_xxx) or name.
send-campaignInviofullSend 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 argomenti
idstringobbligatorioCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.send_strategy"immediate" | "throttled" | "local_time" | "smart_time"immediate (default); throttled: send_options.per_hour; local_time: send_options.local_time "YYYY-MM-DDTHH:mm" in each contact's time zone (send_options.timezone for the rest); smart_time: each contact at their usual engagement hour within send_options.window_hours (default 24).send_optionsobject
get-campaign-statsLetturafullResults of a sent campaign: delivered, opens, clicks, bounces, unsubscribes, mailbox providers, and A/B variant results with the leader and its significance.
1 argomento
idstringobbligatorioCampaign ID (cmp_xxx) or name.
cancel-campaignDistruttivofullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 argomento
idstringobbligatorioCampaign ID (cmp_xxx) or name.
E-commerce: prodotti, ordini, carrelli e coupon commerce
list-productsLetturafullAlphaList the product catalog used by product blocks ({{products ...}}), recommendations and order items.
5 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringcategorystringstatus"active" | "archived" | "all"
get-productLetturafullAlphaRetrieve one product by Emailit id (prd_xxx) or your shop id.
1 argomento
idstringobbligatorioProduct ID (prd_xxx) or the id in your shop.
upsert-productModificafullAlphaCreate a product, or update it when the shop id exists. Only the fields sent are changed.
14 argomenti
idstring | numberobbligatorioThe product id in your shop.titlestringskustringdescriptionstringurlstringimage_urlstringpricenumber | stringcompare_at_pricenumber | stringOriginal price; above price means on sale.currencystringISO 4217, e.g. EUR.categoriesstring[]brandstringinventory_quantitynumber | null0 hides it from recommendations; null = not tracked.status"active" | "archived"metadataobject
upsert-productsModificafullAlphaSync up to 1,000 products at once. Invalid ones are reported and skipped.
1 argomento
productsobject[]obbligatorio
delete-productEliminazionefullAlphaDelete a product from the catalog. Orders keep their item details.
1 argomento
idstringobbligatorioProduct ID (prd_xxx) or the id in your shop.
list-ordersLetturafullAlphaList orders, optionally by contact, status, or the campaign or automation they are attributed to.
10 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).contact_idstringemailstringstatus"placed" | "paid" | "fulfilled" | "canceled" | "refunded"campaign_idstringOrders attributed to this campaign.automation_idstringattributedbooleantrue: only orders credited to an email.fromstringtostring
get-orderLetturafullAlphaRetrieve an order with its items and attribution.
1 argomento
idstringobbligatorioOrder ID (ord_xxx) or the id in your shop.
upsert-orderModificafullAlphaRecord 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 argomenti
idstring | numberobbligatorioThe order id in your shop. Sending the same id again updates the order.emailstringBuyer email. A new buyer becomes a contact unless create_contact is false.contact_idstringfirst_namestringlast_namestringstatus"placed" | "paid" | "fulfilled" | "canceled" | "refunded"currencystringISO 4217; defaults to the workspace commerce currency.subtotalnumber | stringdiscountnumber | stringshippingnumber | stringtaxnumber | stringtotalnumber | stringComputed from items when omitted.coupon_codesstring[]cart_idstringConverts the cart with this id.placed_atstringISO 8601; defaults to now.itemsobject[]create_contactbooleanaccepts_marketingbooleanWith audience_id: subscribe the buyer.audience_idstringmetadataobject
update-order-statusModificafullAlphaMark an order paid, fulfilled, canceled or refunded. Canceled orders stop counting as revenue; refunds are subtracted.
3 argomenti
idstringobbligatorioOrder ID (ord_xxx) or the id in your shop.status"placed" | "paid" | "fulfilled" | "canceled" | "refunded"refunded_amountnumber | string
list-cartsLetturafullAlphaList shopping carts: active, abandoned (idle past the commerce settings delay) or converted.
4 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"active" | "abandoned" | "converted"contact_idstring
upsert-cartModificafullAlphaRecord the buyer's current cart. Idle carts of known contacts become abandoned and emit cart.abandoned.
7 argomenti
idstring | numberobbligatorioThe cart or checkout id in your shop.emailstringcontact_idstringcurrencystringtotalnumber | stringitemsobject[]checkout_urlstring
list-couponsLetturafullAlphaList coupons with how many codes are available, assigned and redeemed. Content uses them as {{coupon "key"}}.
3 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstring
get-couponLetturafullAlphaRetrieve a coupon by id (cpn_xxx) or key.
1 argomento
idstringobbligatorioCoupon ID (cpn_xxx) or key.
create-couponCreazionefullAlphaCreate 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 argomenti
keystringobbligatorioUsed in content as {{coupon "key"}}: lowercase letters, digits, "-" or "_".namestringobbligatoriokind"unique" | "static"static_codestringdiscount_labelstringFor people, e.g. "20% off".expires_atstringcodesstring[]Initial codes for a unique coupon.
add-coupon-codesCreazionefullAlphaAdd codes to a unique coupon, or generate random ones (then create the same codes in your shop). Duplicates are skipped.
3 argomenti
idstringobbligatorioCoupon ID (cpn_xxx) or key.codesstring[]generateobject
get-commerce-settingsLetturafullAlphaCurrency, attribution windows (days after a click or an open) and the cart abandonment delay.
update-commerce-settingsModificafullAlphaRuolo AdminChange the commerce currency, attribution windows or cart abandonment delay. Attribution changes apply to new orders.
4 argomenti
currencystringattribution_click_daysnumberattribution_open_daysnumber0 credits clicks only.cart_abandon_minutesnumber
get-commerce-overviewLetturafullAlphaRevenue, 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 argomenti
fromstringtostring
get-contact-commerceLetturafullAlphaA contact's purchase metrics (orders, spend, AOV, expected next order, churn risk), recent orders, open cart and recently viewed products.
1 argomento
idstringobbligatorioContact ID (con_xxx) or email.
Automazioni automations
list-automationsLetturafullList automations with context, status, and name filters.
7 argomenti
pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).context"contact" | "email" | "event"status"draft" | "running" | "paused" | "stopped" | "archived"namestringName contains.sort"name" | "created_at" | "updated_at" | "last_triggered_at"order"asc" | "desc"
get-automationLetturafullRetrieve an automation with its steps and connections.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
create-automationCreazionefullSave 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 argomenti
context"contact" | "email" | "event"obbligatorioWhat the automation runs on.namestringobbligatoriodescriptionstring | nullsettingsobjectstepsobject[]obbligatorioconnectionsobject[]obbligatorio
update-automationDistruttivofullChange 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 argomenti
idstringobbligatorioAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationEliminazionefullDelete an automation. New events no longer start runs; runs already in progress finish.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
start-automationInviofullStart 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 argomento
idstringobbligatorioAutomation ID (aut_xxx).
pause-automationAzionefullPause an automation so new events don't start runs. Runs already in progress keep going.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
stop-automationDistruttivofullStop an automation and cancel every run in progress. Canceled runs can't be resumed, even if the automation is started again.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
trigger-automationInviofullStart 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 argomenti
idstringobbligatorioAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLetturafullList runs of an automation, optionally by status or contact.
5 argomenti
idstringobbligatorioAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"contact_idstringOnly runs of this contact (con_xxx).
get-automation-runLetturafullRetrieve one automation run with its step history.
2 argomenti
idstringobbligatorioAutomation ID (aut_xxx).run_idstringobbligatorioAutomation run ID.
cancel-automation-runDistruttivofullCancel one running run: its waiting steps are canceled and no further steps run. Can't be undone.
3 argomenti
idstringobbligatorioAutomation ID (aut_xxx).run_idstringobbligatorioAutomation run ID (aur_xxx).reasonstring
remove-contact-from-automationDistruttivofullCancel 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 argomenti
idstringobbligatorioAutomation ID (aut_xxx).contact_idstringContact ID (con_xxx).emailstringContact email, instead of contact_id.reasonstring
list-contact-automation-runsLetturafullList one contact's runs across all automations (latest 100), e.g. to see which workflows they are in.
3 argomenti
contact_idstringContact ID (con_xxx).emailstringContact email, instead of contact_id.status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-statsLetturafullReturn run totals by status and outcome for an automation.
3 argomenti
idstringobbligatorioAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsLetturafullReturn totals for one step, including the delivery funnel for send_email steps.
4 argomenti
idstringobbligatorioAutomation ID (aut_xxx).step_keystringobbligatorioStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Valori globali global_values
list-global-valuesLetturafullList 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-valueLetturafullRetrieve one global value by ID or key.
1 argomento
idstringobbligatorioGlobal value ID (gv_xxx) or key.
create-global-valueCreazionefullCreate a global value, used as {{global.<key>}}. Automations can wait until a date value ("1 day before global.webinar_date").
5 argomenti
keystringobbligatorioLowercase letters, digits and _, starting with a letter.namestring | nulltype"text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.valuestring | number | boolean | nulldescriptionstring | null
update-global-valueModificafullChange 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 argomenti
idstringobbligatorioGlobal value ID (gv_xxx) or key.keystringnamestring | nulltype"text" | "number" | "boolean" | "date" | "datetime" | "url"Default text. date is YYYY-MM-DD, datetime is ISO 8601.valuestring | number | boolean | nulldescriptionstring | null
delete-global-valueEliminazionefullDelete a global value. Templates using it render it empty.
1 argomento
idstringobbligatorioGlobal value ID (gv_xxx) or key.
Moduli forms
list-formsLetturafullList signup forms with name, type, and status filters.
7 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringFree-text search.filtersobject[]Structured filters, combined with AND unless match is "or".match"all" | "or"Combine filters with AND (all, default) or OR.sortstringSort column: name, type, status, created_at.order"asc" | "desc"Sort direction.
get-formLetturafullRetrieve a signup form with its definition and settings.
1 argomento
idstringobbligatorioForm ID (frm_xxx).
create-formCreazionefullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 argomenti
namestringobbligatoriotype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formModificafullUpdate a form name, type, definition, or settings.
5 argomenti
idstringobbligatorioForm ID (frm_xxx).namestringtype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
delete-formEliminazionefullPermanently delete a form. Embedded copies stop working.
1 argomento
idstringobbligatorioForm ID (frm_xxx).
publish-formEsternofullPublish a form so it starts collecting signups from anyone with its link or embed.
1 argomento
idstringobbligatorioForm ID (frm_xxx).
unpublish-formAzionefullTake a form offline. It stops collecting signups.
1 argomento
idstringobbligatorioForm ID (frm_xxx).
reset-form-tokenDistruttivofullRotate the public form token. Existing embed codes stop working until updated.
1 argomento
idstringobbligatorioForm ID (frm_xxx).
Verifica email verification
verify-emailEsternofullCheck whether one address is deliverable. Result is safe, role, catch_all, unknown, inbox_full, disabled, disposable or invalid. Uses verification credits.
2 argomenti
emailstringobbligatoriomode"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-listCreazionefullVerify 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 argomenti
namestringobbligatorioemailsstring[]obbligatorio
list-verification-listsLetturafullList bulk verification lists with their progress.
4 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"searchstring
get-verification-listLetturafullRetrieve a verification list with progress and result counts.
1 argomento
idstringobbligatorioVerification list ID (evl_xxx).
get-verification-list-resultsLetturafullReturn per-address results of a verification list, optionally by status or result.
5 argomenti
idstringobbligatorioVerification list ID (evl_xxx).pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"result"safe" | "role" | "catch_all" | "unknown" | "inbox_full" | "disabled" | "disposable" | "invalid"
Eventi events
list-eventsLetturafullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
5 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).typestringEvent type or comma-separated types, e.g. "email.bounced,email.complained".scope"system" | "workspace" | "custom"Only system events, workspace-defined events (w:), or custom events (c:).include_databooleanInclude the full event payload. Default false.
get-eventLetturafullRetrieve one event with its full payload.
1 argomento
idstringobbligatorioEvent ID (evt_xxx).
send-eventCreazioneeventsRecord 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 argomenti
typestringobbligatoriow:<name> or c:<name>, e.g. "c:order.completed".propertiesobjectEvent payload.emailstringContact email to attribute the event to.contact_idstringContact ID (con_xxx).occurred_atstringISO 8601 time it happened. Defaults to now.
list-workspace-eventsLetturafullList the workspace-defined event types (sent as w:<name>) with their typed properties.
3 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 250).searchstringMatch name or title.
get-workspace-eventLetturafullRetrieve one workspace event definition.
1 argomento
idstringobbligatorioDefinition ID (etp_xxx), name, or w:name.
create-workspace-eventCreazionefullDefine a workspace event and its typed properties (string, number, date, boolean). Send it afterwards as w:<name>. Pro and Business plans.
4 argomenti
namestringobbligatorioEvent name, e.g. "customer.type".titlestringdescriptionstringpropertiesobject[]
update-workspace-eventModificafullUpdate a workspace event definition. `properties`, when given, replaces the whole list. Stored events are not changed.
5 argomenti
idstringobbligatorioDefinition ID (etp_xxx), name, or w:name.namestringtitlestringdescriptionstringpropertiesobject[]
delete-workspace-eventEliminazionefullDelete a workspace event definition. Stored events are kept; new events of this type are rejected.
1 argomento
idstringobbligatorioDefinition ID (etp_xxx), name, or w:name.