Vai al contenuto
Docs

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.

Aggiornato il 2 ott 2026

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-workspaceLetturasending

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

list-workspacesLetturasendingSolo OAuth

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

switch-workspaceModificasendingSolo OAuth

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

1 argomento
  • workspace_id stringobbligatorioWorkspace ID or exact name from list-workspaces.
create-workspaceCreazionefullSolo OAuth

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

1 argomento
  • name stringobbligatorioWorkspace name.

Email emails

send-emailInviosending

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

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

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

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

Retrieve a single email with its status and delivery details.

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
get-email-rawLetturafull

Return the full raw MIME message of an email.

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
get-email-bodyLetturafull

Return the parsed text and HTML body of an email.

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
get-email-attachmentsLetturafull

Return the attachments of an email.

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
get-email-metaLetturafull

Return email metadata and headers without attachment content.

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
update-emailModificasending

Change the send time of a scheduled email.

2 argomenti
  • id stringobbligatorioEmail ID (em_xxx).
  • scheduled_at stringobbligatorioNew send time, ISO 8601.
cancel-emailDistruttivosending

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

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
retry-emailInviosending

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

1 argomento
  • id stringobbligatorioEmail ID (em_xxx).
forward-emailInviosending

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

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

Domini domains

create-domainCreazionefull

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

7 argomenti
  • name stringobbligatorioDomain or subdomain, e.g. mail.acme.com.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
get-domainLetturafull

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

1 argomento
  • id stringobbligatorioDomain ID.
list-domainsLetturafull

List sending domains in the workspace.

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

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

9 argomenti
  • id stringobbligatorioDomain ID.
  • outgoing booleanAllow sending from this domain.
  • incoming booleanAccept inbound email for this domain.
  • use_for_any boolean
  • track_loads booleanTrack opens.
  • track_clicks booleanTrack link clicks.
  • dmarc_reports booleanCollect DMARC aggregate reports.
  • tracking_key string | nullCustom tracking CNAME label.
  • inbound_key string | null
delete-domainEliminazionefullRuolo Admin

Permanently delete a domain. Sending from it stops immediately.

1 argomento
  • id stringobbligatorioDomain ID.
verify-domainAzionefull

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

1 argomento
  • id stringobbligatorioDomain ID.

DMARC dmarc

list-dmarc-reportsLetturafull

List DMARC aggregate or forensic reports received for a domain.

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

Retrieve one DMARC aggregate report with its records.

2 argomenti
  • id stringobbligatorioDomain ID.
  • report_id stringobbligatorioDMARC report ID.
list-dmarc-forensic-reportsLetturafull

List DMARC forensic (failure) reports for a domain.

5 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportLetturafull

Retrieve one DMARC forensic report.

2 argomenti
  • id stringobbligatorioDomain ID.
  • report_id stringobbligatorioForensic report ID.
get-dmarc-statsLetturafull

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

3 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesLetturafull

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

3 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesLetturafull

DMARC message volume by sending country.

3 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsLetturafull

DMARC message volume by sending network (ASN).

3 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersLetturafull

Organizations that sent DMARC reports for the domain.

3 argomenti
  • id stringobbligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportCreazionefull

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

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

Template templates

create-templateCreazionefull

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

8 argomenti
  • name stringobbligatorio
  • alias stringobbligatorioUnique slug used by send-email.
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
get-templateLetturafull

Retrieve a template with its content.

1 argomento
  • id stringobbligatorioTemplate ID (tem_xxx).
list-templatesLetturafull

List templates in the workspace.

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

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

9 argomenti
  • id stringobbligatorioTemplate ID (tem_xxx).
  • name string
  • alias string
  • from stringDefault sender.
  • subject stringSubject; supports {{variables}}.
  • reply_to string | string[]
  • html stringHTML body; supports {{variables}}.
  • text string
  • editor "html" | "text" | "dragit" | "tiptap"
delete-templateEliminazionefull

Permanently delete a template.

1 argomento
  • id stringobbligatorioTemplate ID (tem_xxx).
publish-templateAzionefull

Publish the current template draft so new sends use it.

1 argomento
  • id stringobbligatorioTemplate ID (tem_xxx).

Chiavi API api_keys

create-api-keyCreazionefullRuolo Admin

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

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

Retrieve an API key (without its secret).

1 argomento
  • id stringobbligatorioAPI key ID.
list-api-keysLetturafull

List API keys in the workspace.

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

Rename an API key.

2 argomenti
  • id stringobbligatorioAPI key ID.
  • name stringobbligatorio
delete-api-keyEliminazionefullRuolo Admin

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

1 argomento
  • id stringobbligatorioAPI key ID.
regenerate-api-keyDistruttivofullRuolo Admin

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

1 argomento
  • id stringobbligatorioAPI key ID.

Liste e iscritti audiences

create-audienceCreazionefull

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

1 argomento
  • name stringobbligatorio
get-audienceLetturafull

Retrieve an audience with subscriber counts.

1 argomento
  • id stringobbligatorioAudience ID.
list-audiencesLetturafull

List audiences in the workspace.

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

Rename an audience.

2 argomenti
  • id stringobbligatorioAudience ID.
  • name stringobbligatorio
delete-audienceEliminazionefull

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

1 argomento
  • id stringobbligatorioAudience ID.
list-audience-subscribersLetturafull

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

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

Retrieve one subscriber of an audience.

2 argomenti
  • id stringobbligatorioAudience ID.
  • subscriber_id stringobbligatorioSubscriber ID.
add-audience-subscriberCreazionefull

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

5 argomenti
  • id stringobbligatorioAudience ID.
  • email stringobbligatorio
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberModificafull

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

7 argomenti
  • id stringobbligatorioAudience ID.
  • subscriber_id stringobbligatorioSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberEliminazionefull

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

2 argomenti
  • id stringobbligatorioAudience ID.
  • subscriber_id stringobbligatorioSubscriber ID.

Contatti contacts

create-contactCreazionefull

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

6 argomenti
  • email stringobbligatorio
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactLetturafull

Retrieve a contact by ID or email address.

1 argomento
  • id stringobbligatorioContact ID (con_xxx) or email address.
list-contactsLetturafull

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

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

Update a contact. Passing audiences replaces its audience memberships.

7 argomenti
  • id stringobbligatorioContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactEliminazionefull

Permanently delete a contact and its audience memberships.

1 argomento
  • id stringobbligatorioContact ID (con_xxx) or email address.
bulk-update-contactsDistruttivofull

Apply 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"obbligatorio
  • ids string[]obbligatorioContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsLetturafull

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

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

Soppressioni suppressions

create-suppressionCreazionefull

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

4 argomenti
  • email stringobbligatorio
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
get-suppressionLetturafull

Retrieve a suppression by ID or email address.

1 argomento
  • id stringobbligatorioSuppression ID (sup_xxx) or email address.
list-suppressionsLetturafull

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

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

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

4 argomenti
  • id stringobbligatorioSuppression ID (sup_xxx) or email address.
  • type "recipient" | "bounce" | "complaint" | "unsubscribe"
  • reason string
  • keep_until string | number | nullExpiry as ISO 8601, Unix timestamp, or natural language like "in 30 days". Null keeps it forever.
delete-suppressionEliminazionefull

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

1 argomento
  • id stringobbligatorioSuppression ID (sup_xxx) or email address.

Webhook webhooks

create-webhookCreazionefull

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

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

Retrieve a webhook with its subscribed events and filter.

1 argomento
  • id stringobbligatorioWebhook ID (wh_xxx).
list-webhooksLetturafull

List webhooks in the workspace.

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

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

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

Permanently delete a webhook. Pending deliveries are dropped.

1 argomento
  • id stringobbligatorioWebhook ID (wh_xxx).
test-webhookEsternofull

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

2 argomenti
  • id stringobbligatorioWebhook 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-secretDistruttivofull

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

1 argomento
  • id stringobbligatorioWebhook ID (wh_xxx).
retry-failed-webhook-requestsAzionefull

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

1 argomento
  • id stringobbligatorioWebhook ID (wh_xxx).
retry-webhook-requestAzionefull

Queue one webhook delivery for retry.

2 argomenti
  • id stringobbligatorioWebhook ID (wh_xxx).
  • request_id stringobbligatorioWebhook request ID.

Campagne campaigns

list-campaignsLetturafull

List marketing campaigns, optionally by status.

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

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

1 argomento
  • id stringobbligatorioCampaign ID (cmp_xxx) or name.
create-campaignCreazionefull

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

8 argomenti
  • name stringobbligatorio
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
update-campaignModificafull

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

10 argomenti
  • id stringobbligatorioCampaign ID (cmp_xxx) or name.
  • name string
  • subject string
  • from_email stringSender address on a verified domain.
  • from_name string
  • reply_to string
  • preview_text stringInbox preview text.
  • content stringCampaign body in content_type format.
  • content_type "html" | "text" | "mjml"
  • recipients object[]
delete-campaignEliminazionefull

Permanently delete a campaign that has not been sent.

1 argomento
  • id stringobbligatorioCampaign ID (cmp_xxx) or name.
send-campaignInviofull

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

2 argomenti
  • id stringobbligatorioCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDistruttivofull

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

1 argomento
  • id stringobbligatorioCampaign ID (cmp_xxx) or name.

Automazioni automations

list-automationsLetturafull

List automations with context, status, and name filters.

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

Retrieve an automation with its steps and connections.

1 argomento
  • id stringobbligatorioAutomation ID (aut_xxx).
create-automationCreazionefull

Create 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.
  • name stringobbligatorio
  • description string | null
  • settings object
  • steps object[]obbligatorio
  • connections object[]obbligatorio
update-automationModificafull

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

6 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationEliminazionefull

Delete an automation and stop any runs in progress.

1 argomento
  • id stringobbligatorioAutomation ID (aut_xxx).
start-automationAzionefull

Start or resume an automation so new triggers enroll contacts.

1 argomento
  • id stringobbligatorioAutomation ID (aut_xxx).
pause-automationAzionefull

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

1 argomento
  • id stringobbligatorioAutomation ID (aut_xxx).
stop-automationAzionefull

Stop an automation and cancel runs in progress.

1 argomento
  • id stringobbligatorioAutomation ID (aut_xxx).
trigger-automationInviofull

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

2 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • payload objectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLetturafull

List runs of an automation, optionally by status.

4 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLetturafull

Retrieve one automation run with its step history.

2 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • run_id stringobbligatorioAutomation run ID.
get-automation-statsLetturafull

Return run totals by status and outcome for an automation.

3 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsLetturafull

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

4 argomenti
  • id stringobbligatorioAutomation ID (aut_xxx).
  • step_key stringobbligatorioStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Moduli forms

list-formsLetturafull

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

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

Retrieve a signup form with its definition and settings.

1 argomento
  • id stringobbligatorioForm ID (frm_xxx).
create-formCreazionefull

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

4 argomenti
  • name stringobbligatorio
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
update-formModificafull

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

5 argomenti
  • id stringobbligatorioForm ID (frm_xxx).
  • name string
  • type "popup" | "full_page" | "flyout" | "embed" | "banner"
  • definition objectForm steps and fields. Omit on create to start from the default template.
  • settings objectDisplay and audience settings.
delete-formEliminazionefull

Permanently delete a form. Embedded copies stop working.

1 argomento
  • id stringobbligatorioForm ID (frm_xxx).
publish-formAzionefull

Publish a form so it starts collecting signups.

1 argomento
  • id stringobbligatorioForm ID (frm_xxx).
unpublish-formAzionefull

Take a form offline. It stops collecting signups.

1 argomento
  • id stringobbligatorioForm ID (frm_xxx).
reset-form-tokenDistruttivofull

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

1 argomento
  • id stringobbligatorioForm ID (frm_xxx).

Verifica email verification

verify-emailCreazionefull

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

2 argomenti
  • email stringobbligatorio
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCreazionefull

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

2 argomenti
  • name stringobbligatorio
  • emails string[]obbligatorio
list-verification-listsLetturafull

List bulk verification lists with their progress.

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

Retrieve a verification list with progress and result counts.

1 argomento
  • id stringobbligatorioVerification list ID (evl_xxx).
get-verification-list-resultsLetturafull

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

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

Eventi events

list-eventsLetturafull

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

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

Retrieve one event with its full payload.

1 argomento
  • id stringobbligatorioEvent ID (evt_xxx).

Questa pagina ti è stata utile?

Grazie del feedback.

Grazie, leggiamo ogni messaggio.