Référence
Référence des outils MCP
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.
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-workspaceLecturesendingReturn 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 uniquementList 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 uniquementChange 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_idstringobligatoireWorkspace ID or exact name from list-workspaces.
create-workspaceCréationfullOAuth uniquementCreate a new workspace, give this connection access to it, and switch to it.
1 argument
namestringobligatoireWorkspace name.
E-mails emails
send-emailEnvoisendingSend 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
fromstringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.tostring | string[]obligatoireRecipient 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-emailsLecturefullList sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.
16 arguments
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-emailLecturefullRetrieve a single email with its status and delivery details.
1 argument
idstringobligatoireEmail ID (em_xxx).
get-email-rawLecturefullReturn the full raw MIME message of an email.
1 argument
idstringobligatoireEmail ID (em_xxx).
get-email-bodyLecturefullReturn the parsed text and HTML body of an email.
1 argument
idstringobligatoireEmail ID (em_xxx).
get-email-attachmentsLecturefullReturn the attachments of an email.
1 argument
idstringobligatoireEmail ID (em_xxx).
get-email-metaLecturefullReturn email metadata and headers without attachment content.
1 argument
idstringobligatoireEmail ID (em_xxx).
update-emailMise à joursendingChange the send time of a scheduled email.
2 arguments
idstringobligatoireEmail ID (em_xxx).scheduled_atstringobligatoireNew send time, ISO 8601.
cancel-emailDestructifsendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 argument
idstringobligatoireEmail ID (em_xxx).
retry-emailEnvoisendingRetry delivery of a failed, errored, or held email to its original recipients.
1 argument
idstringobligatoireEmail ID (em_xxx).
forward-emailEnvoisendingForward 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
idstringobligatoireEmail ID (em_xxx).tostring | string[]obligatoireNew 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
Domaines domains
create-domainCréationfullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 arguments
namestringobligatoireDomain 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-domainLecturefullRetrieve a domain with its DNS records and per-record verification status.
1 argument
idstringobligatoireDomain ID.
list-domainsLecturefullList sending domains in the workspace.
7 arguments
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-domainMise à jourfullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 arguments
idstringobligatoireDomain 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-domainSuppressionfullRôle AdminPermanently delete a domain. Sending from it stops immediately.
1 argument
idstringobligatoireDomain ID.
verify-domainActionfullRun a DNS check now and update the verification status of each record.
1 argument
idstringobligatoireDomain ID.
DMARC dmarc
list-dmarc-reportsLecturefullList DMARC aggregate or forensic reports received for a domain.
11 arguments
idstringobligatoireDomain 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-reportLecturefullRetrieve one DMARC aggregate report with its records.
2 arguments
idstringobligatoireDomain ID.report_idstringobligatoireDMARC report ID.
list-dmarc-forensic-reportsLecturefullList DMARC forensic (failure) reports for a domain.
5 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportLecturefullRetrieve one DMARC forensic report.
2 arguments
idstringobligatoireDomain ID.report_idstringobligatoireForensic report ID.
get-dmarc-statsLecturefullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesLecturefullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesLecturefullDMARC message volume by sending country.
3 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsLecturefullDMARC message volume by sending network (ASN).
3 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersLecturefullOrganizations that sent DMARC reports for the domain.
3 arguments
idstringobligatoireDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportCréationfullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 arguments
idstringobligatoireDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Modèles templates
create-templateCréationfullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 arguments
namestringobligatoirealiasstringobligatoireUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateLecturefullRetrieve a template with its content.
1 argument
idstringobligatoireTemplate ID (tem_xxx).
list-templatesLecturefullList templates in the workspace.
7 arguments
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-templateMise à jourfullUpdate a template draft. Publish it to make the change live.
9 arguments
idstringobligatoireTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateSuppressionfullPermanently delete a template.
1 argument
idstringobligatoireTemplate ID (tem_xxx).
publish-templateActionfullPublish the current template draft so new sends use it.
1 argument
idstringobligatoireTemplate ID (tem_xxx).
Clés API api_keys
create-api-keyCréationfullRôle AdminCreate an API key. The secret is returned only once; tell the user to store it securely.
3 arguments
namestringobligatoirescope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyLecturefullRetrieve an API key (without its secret).
1 argument
idstringobligatoireAPI key ID.
list-api-keysLecturefullList API keys in the workspace.
7 arguments
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-keyMise à jourfullRôle AdminRename an API key.
2 arguments
idstringobligatoireAPI key ID.namestringobligatoire
delete-api-keySuppressionfullRôle AdminPermanently revoke an API key. Apps using it stop working immediately.
1 argument
idstringobligatoireAPI key ID.
regenerate-api-keyDestructiffullRôle AdminIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 argument
idstringobligatoireAPI key ID.
Listes et abonnés audiences
create-audienceCréationfullCreate an audience (mailing list) for campaigns and automations.
1 argument
namestringobligatoire
get-audienceLecturefullRetrieve an audience with subscriber counts.
1 argument
idstringobligatoireAudience ID.
list-audiencesLecturefullList audiences in the workspace.
7 arguments
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-audienceMise à jourfullRename an audience.
2 arguments
idstringobligatoireAudience ID.namestringobligatoire
delete-audienceSuppressionfullPermanently delete an audience and its subscriber records. Contacts are kept.
1 argument
idstringobligatoireAudience ID.
list-audience-subscribersLecturefullList subscribers of an audience, optionally only subscribed or unsubscribed.
9 arguments
idstringobligatoireAudience 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-subscriberLecturefullRetrieve one subscriber of an audience.
2 arguments
idstringobligatoireAudience ID.subscriber_idstringobligatoireSubscriber ID.
add-audience-subscriberCréationfullAdd an email address to an audience. Creates the contact if it does not exist.
5 arguments
idstringobligatoireAudience ID.emailstringobligatoirefirst_namestringlast_namestringcustom_fieldsobject
update-audience-subscriberMise à jourfullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 arguments
idstringobligatoireAudience ID.subscriber_idstringobligatoireSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberSuppressionfullRemove a subscriber from an audience. The contact is kept.
2 arguments
idstringobligatoireAudience ID.subscriber_idstringobligatoireSubscriber ID.
Contacts contacts
create-contactCréationfullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 arguments
emailstringobligatoirefirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
get-contactLecturefullRetrieve a contact by ID or email address.
1 argument
idstringobligatoireContact ID (con_xxx) or email address.
list-contactsLecturefullList contacts with search, audience, subscription, and custom-field filters.
9 arguments
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-contactMise à jourfullUpdate a contact. Passing audiences replaces its audience memberships.
7 arguments
idstringobligatoireContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactSuppressionfullPermanently delete a contact and its audience memberships.
1 argument
idstringobligatoireContact ID (con_xxx) or email address.
bulk-update-contactsDestructiffullApply 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"obligatoireidsstring[]obligatoireContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsLecturefullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
9 arguments
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
Adresses bloquées suppressions
create-suppressionCréationfullAdd an email address to the suppression list so Emailit never sends to it.
4 arguments
emailstringobligatoiretype"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-suppressionLecturefullRetrieve a suppression by ID or email address.
1 argument
idstringobligatoireSuppression ID (sup_xxx) or email address.
list-suppressionsLecturefullList suppressed addresses with search, type, reason, and expiry filters.
7 arguments
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-suppressionMise à jourfullChange the type, reason, or expiry of a suppression.
4 arguments
idstringobligatoireSuppression 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-suppressionSuppressionfullRemove an address from the suppression list so it can receive email again.
1 argument
idstringobligatoireSuppression ID (sup_xxx) or email address.
Webhooks webhooks
create-webhookCréationfullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 arguments
namestringobligatoireurlstringobligatoireHTTPS 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-webhookLecturefullRetrieve a webhook with its subscribed events and filter.
1 argument
idstringobligatoireWebhook ID (wh_xxx).
list-webhooksLecturefullList webhooks in the workspace.
7 arguments
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-webhookMise à jourfullUpdate a webhook URL, name, events, filter, or enable it again.
7 arguments
idstringobligatoireWebhook 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-webhookSuppressionfullPermanently delete a webhook. Pending deliveries are dropped.
1 argument
idstringobligatoireWebhook ID (wh_xxx).
test-webhookExternefullSend a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.
2 arguments
idstringobligatoireWebhook 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-secretDestructiffullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 argument
idstringobligatoireWebhook ID (wh_xxx).
retry-failed-webhook-requestsActionfullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 argument
idstringobligatoireWebhook ID (wh_xxx).
retry-webhook-requestActionfullQueue one webhook delivery for retry.
2 arguments
idstringobligatoireWebhook ID (wh_xxx).request_idstringobligatoireWebhook request ID.
Campagnes campaigns
list-campaignsLecturefullList marketing campaigns, optionally by status.
4 arguments
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringSearch by name or subject.status"all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignLecturefullRetrieve a campaign with its content, recipients, and stats.
1 argument
idstringobligatoireCampaign ID (cmp_xxx) or name.
create-campaignCréationfullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
8 arguments
namestringobligatoiresubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignMise à jourfullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 arguments
idstringobligatoireCampaign 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-campaignSuppressionfullPermanently delete a campaign that has not been sent.
1 argument
idstringobligatoireCampaign ID (cmp_xxx) or name.
send-campaignEnvoifullSend a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.
2 arguments
idstringobligatoireCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
cancel-campaignDestructiffullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 argument
idstringobligatoireCampaign ID (cmp_xxx) or name.
Automatisations automations
list-automationsLecturefullList automations with context, status, and name filters.
7 arguments
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-automationLecturefullRetrieve an automation with its steps and connections.
1 argument
idstringobligatoireAutomation ID (aut_xxx).
create-automationCréationfullCreate 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.namestringobligatoiredescriptionstring | nullsettingsobjectstepsobject[]obligatoireconnectionsobject[]obligatoire
update-automationMise à jourfullUpdate an automation. Passing steps or connections replaces the whole graph.
6 arguments
idstringobligatoireAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationSuppressionfullDelete an automation and stop any runs in progress.
1 argument
idstringobligatoireAutomation ID (aut_xxx).
start-automationActionfullStart or resume an automation so new triggers enroll contacts.
1 argument
idstringobligatoireAutomation ID (aut_xxx).
pause-automationActionfullPause an automation. Runs in progress wait until it is started again.
1 argument
idstringobligatoireAutomation ID (aut_xxx).
stop-automationActionfullStop an automation and cancel runs in progress.
1 argument
idstringobligatoireAutomation ID (aut_xxx).
trigger-automationEnvoifullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 arguments
idstringobligatoireAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLecturefullList runs of an automation, optionally by status.
4 arguments
idstringobligatoireAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLecturefullRetrieve one automation run with its step history.
2 arguments
idstringobligatoireAutomation ID (aut_xxx).run_idstringobligatoireAutomation run ID.
get-automation-statsLecturefullReturn run totals by status and outcome for an automation.
3 arguments
idstringobligatoireAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsLecturefullReturn totals for one step, including the delivery funnel for send_email steps.
4 arguments
idstringobligatoireAutomation ID (aut_xxx).step_keystringobligatoireStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Formulaires forms
list-formsLecturefullList signup forms with name, type, and status filters.
7 arguments
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-formLecturefullRetrieve a signup form with its definition and settings.
1 argument
idstringobligatoireForm ID (frm_xxx).
create-formCréationfullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 arguments
namestringobligatoiretype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formMise à jourfullUpdate a form name, type, definition, or settings.
5 arguments
idstringobligatoireForm 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-formSuppressionfullPermanently delete a form. Embedded copies stop working.
1 argument
idstringobligatoireForm ID (frm_xxx).
publish-formActionfullPublish a form so it starts collecting signups.
1 argument
idstringobligatoireForm ID (frm_xxx).
unpublish-formActionfullTake a form offline. It stops collecting signups.
1 argument
idstringobligatoireForm ID (frm_xxx).
reset-form-tokenDestructiffullRotate the public form token. Existing embed codes stop working until updated.
1 argument
idstringobligatoireForm ID (frm_xxx).
Vérification d’e-mails verification
verify-emailCréationfullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 arguments
emailstringobligatoiremode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCréationfullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
2 arguments
namestringobligatoireemailsstring[]obligatoire
list-verification-listsLecturefullList bulk verification lists with their progress.
4 arguments
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"searchstring
get-verification-listLecturefullRetrieve a verification list with progress and result counts.
1 argument
idstringobligatoireVerification list ID (evl_xxx).
get-verification-list-resultsLecturefullReturn per-address results of a verification list, optionally by status or result.
5 arguments
idstringobligatoireVerification 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"
Événements events
list-eventsLecturefullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
4 arguments
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-eventLecturefullRetrieve one event with its full payload.
1 argument
idstringobligatoireEvent ID (evt_xxx).