Aller au contenu
Docs

Référence

Tous les outils du serveur MCP Emailit hébergé, classés par groupe d’outils, avec leur type, la portée requise, le rôle requis et leurs arguments.

Mis à jour le 2 oct. 2026

Le serveur hébergé à l’adresse https://api.emailit.com/mcp expose 109 outils répartis en 15 groupes d’outils. Cette référence est générée à partir du catalogue d’outils du serveur : elle correspond donc toujours à ce que voit votre assistant. Les descriptions des outils et des arguments sont affichées telles que le serveur les envoie, en anglais.

Portée. Les outils de portée sending fonctionnent aussi avec full. Consultez Espaces de travail et droits d’accès.

Type. Lecture n’effectue aucune modification. Création et mise à jour modifient des données. Action modifie un état. Suppression supprime des données. Destructif est irréversible. Externe appelle une URL qui vous appartient. Envoi atteint de vrais destinataires. Les types correspondent aux annotations d’outils MCP (readOnlyHint, destructiveHint, idempotentHint, openWorldHint) : les clients peuvent ainsi demander confirmation avant d’exécuter des outils d’écriture.

Espace de travail. Avec OAuth, chaque outil en dehors du groupe d’outils Espace de travail accepte aussi un argument facultatif workspace (ID ou nom exact) pour exécuter cet appel dans un autre espace de travail autorisé. Les outils marqués Rôle Admin sont refusés avec admin_role_required pour les membres ayant le rôle Member. Les connexions par clé API n’ont ni argument workspace ni limites liées au rôle.

Résultats. Les outils renvoient du JSON sous forme de texte pour tous les clients, et sous forme de structuredContent pour les clients qui lisent les résultats structurés. Les outils de liste acceptent page, limit et des filtres structurés ({ field, condition, value }).

Espace de travail workspace

get-current-workspaceLecturesending

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-workspacesLecturesendingOAuth uniquement

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-workspaceMise à joursendingOAuth uniquement

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

1 argument
  • workspace_id stringobligatoireWorkspace ID or exact name from list-workspaces.
create-workspaceCréationfullOAuth uniquement

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

1 argument
  • name stringobligatoireWorkspace name.

E-mails emails

send-emailEnvoisending

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

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

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

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

Retrieve a single email with its status and delivery details.

1 argument
  • id stringobligatoireEmail ID (em_xxx).
get-email-rawLecturefull

Return the full raw MIME message of an email.

1 argument
  • id stringobligatoireEmail ID (em_xxx).
get-email-bodyLecturefull

Return the parsed text and HTML body of an email.

1 argument
  • id stringobligatoireEmail ID (em_xxx).
get-email-attachmentsLecturefull

Return the attachments of an email.

1 argument
  • id stringobligatoireEmail ID (em_xxx).
get-email-metaLecturefull

Return email metadata and headers without attachment content.

1 argument
  • id stringobligatoireEmail ID (em_xxx).
update-emailMise à joursending

Change the send time of a scheduled email.

2 arguments
  • id stringobligatoireEmail ID (em_xxx).
  • scheduled_at stringobligatoireNew send time, ISO 8601.
cancel-emailDestructifsending

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

1 argument
  • id stringobligatoireEmail ID (em_xxx).
retry-emailEnvoisending

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

1 argument
  • id stringobligatoireEmail ID (em_xxx).
forward-emailEnvoisending

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

9 arguments
  • id stringobligatoireEmail ID (em_xxx).
  • to string | string[]obligatoireNew 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

Domaines domains

create-domainCréationfull

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

7 arguments
  • name stringobligatoireDomain 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-domainLecturefull

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

1 argument
  • id stringobligatoireDomain ID.
list-domainsLecturefull

List sending domains in the workspace.

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

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

9 arguments
  • id stringobligatoireDomain 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-domainSuppressionfullRôle Admin

Permanently delete a domain. Sending from it stops immediately.

1 argument
  • id stringobligatoireDomain ID.
verify-domainActionfull

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

1 argument
  • id stringobligatoireDomain ID.

DMARC dmarc

list-dmarc-reportsLecturefull

List DMARC aggregate or forensic reports received for a domain.

11 arguments
  • id stringobligatoireDomain 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-reportLecturefull

Retrieve one DMARC aggregate report with its records.

2 arguments
  • id stringobligatoireDomain ID.
  • report_id stringobligatoireDMARC report ID.
list-dmarc-forensic-reportsLecturefull

List DMARC forensic (failure) reports for a domain.

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

Retrieve one DMARC forensic report.

2 arguments
  • id stringobligatoireDomain ID.
  • report_id stringobligatoireForensic report ID.
get-dmarc-statsLecturefull

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

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

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

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

DMARC message volume by sending country.

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

DMARC message volume by sending network (ASN).

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

Organizations that sent DMARC reports for the domain.

3 arguments
  • id stringobligatoireDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportCréationfull

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

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

Modèles templates

create-templateCréationfull

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

8 arguments
  • name stringobligatoire
  • alias stringobligatoireUnique 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-templateLecturefull

Retrieve a template with its content.

1 argument
  • id stringobligatoireTemplate ID (tem_xxx).
list-templatesLecturefull

List templates in the workspace.

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

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

9 arguments
  • id stringobligatoireTemplate 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-templateSuppressionfull

Permanently delete a template.

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

Publish the current template draft so new sends use it.

1 argument
  • id stringobligatoireTemplate ID (tem_xxx).

Clés API api_keys

create-api-keyCréationfullRôle Admin

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

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

Retrieve an API key (without its secret).

1 argument
  • id stringobligatoireAPI key ID.
list-api-keysLecturefull

List API keys in the workspace.

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

Rename an API key.

2 arguments
  • id stringobligatoireAPI key ID.
  • name stringobligatoire
delete-api-keySuppressionfullRôle Admin

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

1 argument
  • id stringobligatoireAPI key ID.
regenerate-api-keyDestructiffullRôle Admin

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

1 argument
  • id stringobligatoireAPI key ID.

Listes et abonnés audiences

create-audienceCréationfull

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

1 argument
  • name stringobligatoire
get-audienceLecturefull

Retrieve an audience with subscriber counts.

1 argument
  • id stringobligatoireAudience ID.
list-audiencesLecturefull

List audiences in the workspace.

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

Rename an audience.

2 arguments
  • id stringobligatoireAudience ID.
  • name stringobligatoire
delete-audienceSuppressionfull

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

1 argument
  • id stringobligatoireAudience ID.
list-audience-subscribersLecturefull

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

9 arguments
  • id stringobligatoireAudience 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-subscriberLecturefull

Retrieve one subscriber of an audience.

2 arguments
  • id stringobligatoireAudience ID.
  • subscriber_id stringobligatoireSubscriber ID.
add-audience-subscriberCréationfull

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

5 arguments
  • id stringobligatoireAudience ID.
  • email stringobligatoire
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberMise à jourfull

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

7 arguments
  • id stringobligatoireAudience ID.
  • subscriber_id stringobligatoireSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberSuppressionfull

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

2 arguments
  • id stringobligatoireAudience ID.
  • subscriber_id stringobligatoireSubscriber ID.

Contacts contacts

create-contactCréationfull

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

6 arguments
  • email stringobligatoire
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactLecturefull

Retrieve a contact by ID or email address.

1 argument
  • id stringobligatoireContact ID (con_xxx) or email address.
list-contactsLecturefull

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

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

Update a contact. Passing audiences replaces its audience memberships.

7 arguments
  • id stringobligatoireContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactSuppressionfull

Permanently delete a contact and its audience memberships.

1 argument
  • id stringobligatoireContact ID (con_xxx) or email address.
bulk-update-contactsDestructiffull

Apply one action to up to 100 contacts: delete, add_to_audience, remove_from_audience, unsubscribe, or resubscribe.

3 arguments
  • action "delete" | "add_to_audience" | "remove_from_audience" | "unsubscribe" | "resubscribe"obligatoire
  • ids string[]obligatoireContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsLecturefull

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

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

Adresses bloquées suppressions

create-suppressionCréationfull

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

4 arguments
  • email stringobligatoire
  • 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-suppressionLecturefull

Retrieve a suppression by ID or email address.

1 argument
  • id stringobligatoireSuppression ID (sup_xxx) or email address.
list-suppressionsLecturefull

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

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

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

4 arguments
  • id stringobligatoireSuppression 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-suppressionSuppressionfull

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

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

Webhooks webhooks

create-webhookCréationfull

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

6 arguments
  • name stringobligatoire
  • url stringobligatoireHTTPS 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-webhookLecturefull

Retrieve a webhook with its subscribed events and filter.

1 argument
  • id stringobligatoireWebhook ID (wh_xxx).
list-webhooksLecturefull

List webhooks in the workspace.

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

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

7 arguments
  • id stringobligatoireWebhook 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-webhookSuppressionfull

Permanently delete a webhook. Pending deliveries are dropped.

1 argument
  • id stringobligatoireWebhook ID (wh_xxx).
test-webhookExternefull

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

2 arguments
  • id stringobligatoireWebhook 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"obligatoireEvent type to send, e.g. email.delivered.
reset-webhook-secretDestructiffull

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

1 argument
  • id stringobligatoireWebhook ID (wh_xxx).
retry-failed-webhook-requestsActionfull

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

1 argument
  • id stringobligatoireWebhook ID (wh_xxx).
retry-webhook-requestActionfull

Queue one webhook delivery for retry.

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

Campagnes campaigns

list-campaignsLecturefull

List marketing campaigns, optionally by status.

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

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

1 argument
  • id stringobligatoireCampaign ID (cmp_xxx) or name.
create-campaignCréationfull

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

8 arguments
  • name stringobligatoire
  • 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-campaignMise à jourfull

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

10 arguments
  • id stringobligatoireCampaign 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-campaignSuppressionfull

Permanently delete a campaign that has not been sent.

1 argument
  • id stringobligatoireCampaign ID (cmp_xxx) or name.
send-campaignEnvoifull

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

2 arguments
  • id stringobligatoireCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDestructiffull

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

1 argument
  • id stringobligatoireCampaign ID (cmp_xxx) or name.

Automatisations automations

list-automationsLecturefull

List automations with context, status, and name filters.

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

Retrieve an automation with its steps and connections.

1 argument
  • id stringobligatoireAutomation ID (aut_xxx).
create-automationCréationfull

Create a draft automation from a trigger step, action steps, and connections between step keys. Start it with start-automation.

6 arguments
  • context "contact" | "email" | "event"obligatoireWhat the automation runs on.
  • name stringobligatoire
  • description string | null
  • settings object
  • steps object[]obligatoire
  • connections object[]obligatoire
update-automationMise à jourfull

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

6 arguments
  • id stringobligatoireAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationSuppressionfull

Delete an automation and stop any runs in progress.

1 argument
  • id stringobligatoireAutomation ID (aut_xxx).
start-automationActionfull

Start or resume an automation so new triggers enroll contacts.

1 argument
  • id stringobligatoireAutomation ID (aut_xxx).
pause-automationActionfull

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

1 argument
  • id stringobligatoireAutomation ID (aut_xxx).
stop-automationActionfull

Stop an automation and cancel runs in progress.

1 argument
  • id stringobligatoireAutomation ID (aut_xxx).
trigger-automationEnvoifull

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

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

List runs of an automation, optionally by status.

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

Retrieve one automation run with its step history.

2 arguments
  • id stringobligatoireAutomation ID (aut_xxx).
  • run_id stringobligatoireAutomation run ID.
get-automation-statsLecturefull

Return run totals by status and outcome for an automation.

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

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

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

Formulaires forms

list-formsLecturefull

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

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

Retrieve a signup form with its definition and settings.

1 argument
  • id stringobligatoireForm ID (frm_xxx).
create-formCréationfull

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

4 arguments
  • name stringobligatoire
  • 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-formMise à jourfull

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

5 arguments
  • id stringobligatoireForm 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-formSuppressionfull

Permanently delete a form. Embedded copies stop working.

1 argument
  • id stringobligatoireForm ID (frm_xxx).
publish-formActionfull

Publish a form so it starts collecting signups.

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

Take a form offline. It stops collecting signups.

1 argument
  • id stringobligatoireForm ID (frm_xxx).
reset-form-tokenDestructiffull

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

1 argument
  • id stringobligatoireForm ID (frm_xxx).

Vérification d’e-mails verification

verify-emailCréationfull

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

2 arguments
  • email stringobligatoire
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCréationfull

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

2 arguments
  • name stringobligatoire
  • emails string[]obligatoire
list-verification-listsLecturefull

List bulk verification lists with their progress.

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

Retrieve a verification list with progress and result counts.

1 argument
  • id stringobligatoireVerification list ID (evl_xxx).
get-verification-list-resultsLecturefull

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

5 arguments
  • id stringobligatoireVerification 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"

Événements events

list-eventsLecturefull

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

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

Retrieve one event with its full payload.

1 argument
  • id stringobligatoireEvent ID (evt_xxx).

Cette page vous a-t-elle été utile ?

Merci pour votre retour.

Merci, nous lisons chaque message.