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 109 strumenti in 15 toolset (gruppi di strumenti). 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 chiama un URL di tua proprietà. 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.
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-domainAzionefullRun a DNS check 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).
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.
1 argomento
namestringobbligatorio
get-audienceLetturafullRetrieve an audience with subscriber counts.
1 argomento
idstringobbligatorioAudience ID.
list-audiencesLetturafullList audiences 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.order"asc" | "desc"Sort direction.
update-audienceModificafullRename an audience.
2 argomenti
idstringobbligatorioAudience ID.namestringobbligatorio
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.
9 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, created_at.order"asc" | "desc"Sort direction.subscribedboolean
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.
5 argomenti
idstringobbligatorioAudience ID.emailstringobbligatoriofirst_namestringlast_namestringcustom_fieldsobject
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.
Contatti contacts
create-contactCreazionefullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 argomenti
emailstringobbligatoriofirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
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.
9 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, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedboolean
update-contactModificafullUpdate a contact. Passing audiences replaces its audience memberships.
7 argomenti
idstringobbligatorioContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactEliminazionefullPermanently delete a contact and its audience memberships.
1 argomento
idstringobbligatorioContact ID (con_xxx) or email address.
bulk-update-contactsDistruttivofullApply one action to up to 100 contacts: delete, add_to_audience, remove_from_audience, unsubscribe, or resubscribe.
3 argomenti
action"delete" | "add_to_audience" | "remove_from_audience" | "unsubscribe" | "resubscribe"obbligatorioidsstring[]obbligatorioContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsLetturafullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
9 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, audience_id, custom_fields.<key>.order"asc" | "desc"Sort direction.audience_idstringOnly contacts in this audience.unsubscribedboolean
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-webhookCreazionefullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 argomenti
namestringobbligatoriourlstringobbligatorioHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every event type.enabledbooleanevents"email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"[]Event types to subscribe to when all_events is false.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
get-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-webhookModificafullUpdate a webhook URL, name, events, filter, or enable it again.
7 argomenti
idstringobbligatorioWebhook ID (wh_xxx).namestringurlstringHTTPS endpoint that receives event POSTs.all_eventsbooleanSubscribe to every event type.enabledbooleanevents"email.accepted" | "email.scheduled" | "email.delivered" | "email.bounced" | "email.attempted" | "email.failed" | "email.rejected" | "email.clicked" | "email.loaded" | "email.complained" | "email.received" | "email.suppressed" | "email.canceled" | "email.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"[]Event types to subscribe to when all_events is false.filterobject | nullOnly deliver events matching these rules. Null clears the filter.
delete-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.unsubscribed" | "email.resubscribed" | "domain.created" | "domain.updated" | "domain.deleted" | "audience.created" | "audience.updated" | "audience.deleted" | "subscriber.created" | "subscriber.updated" | "subscriber.deleted" | "contact.created" | "contact.updated" | "contact.deleted" | "template.created" | "template.updated" | "template.deleted" | "suppression.created" | "suppression.updated" | "suppression.deleted" | "email_verification.created" | "email_verification.updated" | "email_verification_list.created" | "email_verification_list.updated" | "campaign.created" | "campaign.updated" | "campaign.deleted" | "campaign.scheduled" | "campaign.queued" | "campaign.sending" | "campaign.testing" | "campaign.sent" | "campaign.canceled" | "campaign.archived"obbligatorioEvent type to send, e.g. email.delivered.
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-requestsAzionefullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 argomento
idstringobbligatorioWebhook ID (wh_xxx).
retry-webhook-requestAzionefullQueue one webhook delivery for retry.
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.
8 argomenti
namestringobbligatoriosubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignModificafullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 argomenti
idstringobbligatorioCampaign ID (cmp_xxx) or name.namestringsubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"recipientsobject[]
delete-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. Delivers to real subscribers, so confirm with the user first.
2 argomenti
idstringobbligatorioCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
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.
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-automationCreazionefullCreate a draft automation from a trigger step, action steps, and connections between step keys. Start it with start-automation.
6 argomenti
context"contact" | "email" | "event"obbligatorioWhat the automation runs on.namestringobbligatoriodescriptionstring | nullsettingsobjectstepsobject[]obbligatorioconnectionsobject[]obbligatorio
update-automationModificafullUpdate an automation. Passing steps or connections replaces the whole graph.
6 argomenti
idstringobbligatorioAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationEliminazionefullDelete an automation and stop any runs in progress.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
start-automationAzionefullStart or resume an automation so new triggers enroll contacts.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
pause-automationAzionefullPause an automation. Runs in progress wait until it is started again.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
stop-automationAzionefullStop an automation and cancel runs in progress.
1 argomento
idstringobbligatorioAutomation ID (aut_xxx).
trigger-automationInviofullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 argomenti
idstringobbligatorioAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLetturafullList runs of an automation, optionally by status.
4 argomenti
idstringobbligatorioAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLetturafullRetrieve one automation run with its step history.
2 argomenti
idstringobbligatorioAutomation ID (aut_xxx).run_idstringobbligatorioAutomation run ID.
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.
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-formAzionefullPublish a form so it starts collecting signups.
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-emailCreazionefullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 argomenti
emailstringobbligatoriomode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCreazionefullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
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" | "invalid" | "disposable" | "disabled" | "inbox_full" | "unknown"
Eventi events
list-eventsLetturafullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
4 argomenti
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).typestringEvent type or comma-separated types, e.g. "email.bounced,email.complained".include_databooleanInclude the full event payload. Default false.
get-eventLetturafullRetrieve one event with its full payload.
1 argomento
idstringobbligatorioEvent ID (evt_xxx).