Pular para o conteúdo
Docs

Referência

Referência de ferramentas MCP

Todas as ferramentas do servidor MCP hospedado do Emailit, agrupadas por toolset, com tipo, escopo exigido, exigência de papel e argumentos.

Atualizado em 2 de out. de 2026

O servidor hospedado em https://api.emailit.com/mcp expõe 109 ferramentas em 15 toolsets. Esta referência é gerada a partir do catálogo de ferramentas do servidor, então sempre corresponde ao que o seu assistente vê. As descrições das ferramentas e dos argumentos aparecem como o servidor as envia, em inglês.

Escopo. As ferramentas com escopo sending também funcionam com full. Consulte Workspaces e permissões.

Tipo. Leitura não faz alterações. Criação e Atualização alteram dados. Ação altera um estado. Exclusão remove dados. Destrutiva não pode ser desfeita. Externa chama uma URL sua. Envio chega a destinatários reais. Os tipos correspondem às anotações de ferramentas do MCP (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), para que os clientes possam perguntar antes de executar ferramentas de escrita.

Workspace. Com OAuth, todas as ferramentas fora do toolset Workspace também recebem um argumento opcional workspace (ID ou nome exato) para executar essa chamada em outro workspace permitido. As ferramentas marcadas com Papel Admin são recusadas com admin_role_required para membros com o papel Member. As conexões com chave de API não têm o argumento workspace nem limites de papel.

Resultados. As ferramentas retornam JSON como texto para todos os clientes e como structuredContent para os clientes que leem resultados estruturados. As ferramentas de listagem aceitam page, limit e filtros estruturados ({ field, condition, value }).

Workspace workspace

get-current-workspaceLeiturasending

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-workspacesLeiturasendingApenas 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-workspaceAtualizaçãosendingApenas 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 argumento
  • workspace_id stringobrigatórioWorkspace ID or exact name from list-workspaces.
create-workspaceCriaçãofullApenas OAuth

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

1 argumento
  • name stringobrigatórioWorkspace name.

E-mails emails

send-emailEnviosending

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 argumentos
  • from stringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.
  • to string | string[]obrigatórioRecipient 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-emailsLeiturafull

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

16 argumentos
  • 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-emailLeiturafull

Retrieve a single email with its status and delivery details.

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
get-email-rawLeiturafull

Return the full raw MIME message of an email.

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
get-email-bodyLeiturafull

Return the parsed text and HTML body of an email.

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
get-email-attachmentsLeiturafull

Return the attachments of an email.

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
get-email-metaLeiturafull

Return email metadata and headers without attachment content.

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
update-emailAtualizaçãosending

Change the send time of a scheduled email.

2 argumentos
  • id stringobrigatórioEmail ID (em_xxx).
  • scheduled_at stringobrigatórioNew send time, ISO 8601.
cancel-emailDestrutivasending

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

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
retry-emailEnviosending

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

1 argumento
  • id stringobrigatórioEmail ID (em_xxx).
forward-emailEnviosending

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 argumentos
  • id stringobrigatórioEmail ID (em_xxx).
  • to string | string[]obrigatórioNew 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

Domínios domains

create-domainCriaçãofull

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

7 argumentos
  • name stringobrigatórioDomain 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-domainLeiturafull

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

1 argumento
  • id stringobrigatórioDomain ID.
list-domainsLeiturafull

List sending domains in the workspace.

7 argumentos
  • 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-domainAtualizaçãofull

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

9 argumentos
  • id stringobrigatórioDomain 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-domainExclusãofullPapel Admin

Permanently delete a domain. Sending from it stops immediately.

1 argumento
  • id stringobrigatórioDomain ID.
verify-domainAçãofull

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

1 argumento
  • id stringobrigatórioDomain ID.

DMARC dmarc

list-dmarc-reportsLeiturafull

List DMARC aggregate or forensic reports received for a domain.

11 argumentos
  • id stringobrigatórioDomain 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-reportLeiturafull

Retrieve one DMARC aggregate report with its records.

2 argumentos
  • id stringobrigatórioDomain ID.
  • report_id stringobrigatórioDMARC report ID.
list-dmarc-forensic-reportsLeiturafull

List DMARC forensic (failure) reports for a domain.

5 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportLeiturafull

Retrieve one DMARC forensic report.

2 argumentos
  • id stringobrigatórioDomain ID.
  • report_id stringobrigatórioForensic report ID.
get-dmarc-statsLeiturafull

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

3 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesLeiturafull

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

3 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesLeiturafull

DMARC message volume by sending country.

3 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsLeiturafull

DMARC message volume by sending network (ASN).

3 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersLeiturafull

Organizations that sent DMARC reports for the domain.

3 argumentos
  • id stringobrigatórioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportCriaçãofull

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

4 argumentos
  • id stringobrigatórioDomain ID.
  • content stringRaw report XML.
  • content_base64 stringBase64 of the report file.
  • filename string

Templates templates

create-templateCriaçãofull

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

8 argumentos
  • name stringobrigatório
  • alias stringobrigatórioUnique 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-templateLeiturafull

Retrieve a template with its content.

1 argumento
  • id stringobrigatórioTemplate ID (tem_xxx).
list-templatesLeiturafull

List templates in the workspace.

7 argumentos
  • 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-templateAtualizaçãofull

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

9 argumentos
  • id stringobrigatórioTemplate 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-templateExclusãofull

Permanently delete a template.

1 argumento
  • id stringobrigatórioTemplate ID (tem_xxx).
publish-templateAçãofull

Publish the current template draft so new sends use it.

1 argumento
  • id stringobrigatórioTemplate ID (tem_xxx).

Chaves de API api_keys

create-api-keyCriaçãofullPapel Admin

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

3 argumentos
  • name stringobrigatório
  • scope "full" | "sending"sending = send-only, full = every endpoint.
  • sending_domain_id string | nullLock a sending key to one domain.
get-api-keyLeiturafull

Retrieve an API key (without its secret).

1 argumento
  • id stringobrigatórioAPI key ID.
list-api-keysLeiturafull

List API keys in the workspace.

7 argumentos
  • 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-keyAtualizaçãofullPapel Admin

Rename an API key.

2 argumentos
  • id stringobrigatórioAPI key ID.
  • name stringobrigatório
delete-api-keyExclusãofullPapel Admin

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

1 argumento
  • id stringobrigatórioAPI key ID.
regenerate-api-keyDestrutivafullPapel Admin

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

1 argumento
  • id stringobrigatórioAPI key ID.

Listas e inscritos audiences

create-audienceCriaçãofull

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

1 argumento
  • name stringobrigatório
get-audienceLeiturafull

Retrieve an audience with subscriber counts.

1 argumento
  • id stringobrigatórioAudience ID.
list-audiencesLeiturafull

List audiences in the workspace.

7 argumentos
  • 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-audienceAtualizaçãofull

Rename an audience.

2 argumentos
  • id stringobrigatórioAudience ID.
  • name stringobrigatório
delete-audienceExclusãofull

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

1 argumento
  • id stringobrigatórioAudience ID.
list-audience-subscribersLeiturafull

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

9 argumentos
  • id stringobrigatórioAudience 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-subscriberLeiturafull

Retrieve one subscriber of an audience.

2 argumentos
  • id stringobrigatórioAudience ID.
  • subscriber_id stringobrigatórioSubscriber ID.
add-audience-subscriberCriaçãofull

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

5 argumentos
  • id stringobrigatórioAudience ID.
  • email stringobrigatório
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberAtualizaçãofull

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

7 argumentos
  • id stringobrigatórioAudience ID.
  • subscriber_id stringobrigatórioSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberExclusãofull

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

2 argumentos
  • id stringobrigatórioAudience ID.
  • subscriber_id stringobrigatórioSubscriber ID.

Contatos contacts

create-contactCriaçãofull

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

6 argumentos
  • email stringobrigatório
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactLeiturafull

Retrieve a contact by ID or email address.

1 argumento
  • id stringobrigatórioContact ID (con_xxx) or email address.
list-contactsLeiturafull

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

9 argumentos
  • 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-contactAtualizaçãofull

Update a contact. Passing audiences replaces its audience memberships.

7 argumentos
  • id stringobrigatórioContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactExclusãofull

Permanently delete a contact and its audience memberships.

1 argumento
  • id stringobrigatórioContact ID (con_xxx) or email address.
bulk-update-contactsDestrutivafull

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

3 argumentos
  • action "delete" | "add_to_audience" | "remove_from_audience" | "unsubscribe" | "resubscribe"obrigatório
  • ids string[]obrigatórioContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsLeiturafull

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

9 argumentos
  • 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

Supressões suppressions

create-suppressionCriaçãofull

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

4 argumentos
  • email stringobrigatório
  • 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-suppressionLeiturafull

Retrieve a suppression by ID or email address.

1 argumento
  • id stringobrigatórioSuppression ID (sup_xxx) or email address.
list-suppressionsLeiturafull

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

7 argumentos
  • 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-suppressionAtualizaçãofull

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

4 argumentos
  • id stringobrigatórioSuppression 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-suppressionExclusãofull

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

1 argumento
  • id stringobrigatórioSuppression ID (sup_xxx) or email address.

Webhooks webhooks

create-webhookCriaçãofull

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

6 argumentos
  • name stringobrigatório
  • url stringobrigatórioHTTPS 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-webhookLeiturafull

Retrieve a webhook with its subscribed events and filter.

1 argumento
  • id stringobrigatórioWebhook ID (wh_xxx).
list-webhooksLeiturafull

List webhooks in the workspace.

7 argumentos
  • 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-webhookAtualizaçãofull

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

7 argumentos
  • id stringobrigatórioWebhook 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-webhookExclusãofull

Permanently delete a webhook. Pending deliveries are dropped.

1 argumento
  • id stringobrigatórioWebhook ID (wh_xxx).
test-webhookExternafull

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

2 argumentos
  • id stringobrigatórioWebhook 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"obrigatórioEvent type to send, e.g. email.delivered.
reset-webhook-secretDestrutivafull

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

1 argumento
  • id stringobrigatórioWebhook ID (wh_xxx).
retry-failed-webhook-requestsAçãofull

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

1 argumento
  • id stringobrigatórioWebhook ID (wh_xxx).
retry-webhook-requestAçãofull

Queue one webhook delivery for retry.

2 argumentos
  • id stringobrigatórioWebhook ID (wh_xxx).
  • request_id stringobrigatórioWebhook request ID.

Campanhas campaigns

list-campaignsLeiturafull

List marketing campaigns, optionally by status.

4 argumentos
  • 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-campaignLeiturafull

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

1 argumento
  • id stringobrigatórioCampaign ID (cmp_xxx) or name.
create-campaignCriaçãofull

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

8 argumentos
  • name stringobrigatório
  • 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-campaignAtualizaçãofull

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

10 argumentos
  • id stringobrigatórioCampaign 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-campaignExclusãofull

Permanently delete a campaign that has not been sent.

1 argumento
  • id stringobrigatórioCampaign ID (cmp_xxx) or name.
send-campaignEnviofull

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

2 argumentos
  • id stringobrigatórioCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDestrutivafull

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

1 argumento
  • id stringobrigatórioCampaign ID (cmp_xxx) or name.

Automações automations

list-automationsLeiturafull

List automations with context, status, and name filters.

7 argumentos
  • 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-automationLeiturafull

Retrieve an automation with its steps and connections.

1 argumento
  • id stringobrigatórioAutomation ID (aut_xxx).
create-automationCriaçãofull

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

6 argumentos
  • context "contact" | "email" | "event"obrigatórioWhat the automation runs on.
  • name stringobrigatório
  • description string | null
  • settings object
  • steps object[]obrigatório
  • connections object[]obrigatório
update-automationAtualizaçãofull

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

6 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationExclusãofull

Delete an automation and stop any runs in progress.

1 argumento
  • id stringobrigatórioAutomation ID (aut_xxx).
start-automationAçãofull

Start or resume an automation so new triggers enroll contacts.

1 argumento
  • id stringobrigatórioAutomation ID (aut_xxx).
pause-automationAçãofull

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

1 argumento
  • id stringobrigatórioAutomation ID (aut_xxx).
stop-automationAçãofull

Stop an automation and cancel runs in progress.

1 argumento
  • id stringobrigatórioAutomation ID (aut_xxx).
trigger-automationEnviofull

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

2 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • payload objectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLeiturafull

List runs of an automation, optionally by status.

4 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • page numberPage number (default: 1).
  • per_page numberResults per page (max: 100).
  • status "running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLeiturafull

Retrieve one automation run with its step history.

2 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • run_id stringobrigatórioAutomation run ID.
get-automation-statsLeiturafull

Return run totals by status and outcome for an automation.

3 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsLeiturafull

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

4 argumentos
  • id stringobrigatórioAutomation ID (aut_xxx).
  • step_key stringobrigatórioStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Formulários forms

list-formsLeiturafull

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

7 argumentos
  • 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-formLeiturafull

Retrieve a signup form with its definition and settings.

1 argumento
  • id stringobrigatórioForm ID (frm_xxx).
create-formCriaçãofull

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

4 argumentos
  • name stringobrigatório
  • 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-formAtualizaçãofull

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

5 argumentos
  • id stringobrigatórioForm 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-formExclusãofull

Permanently delete a form. Embedded copies stop working.

1 argumento
  • id stringobrigatórioForm ID (frm_xxx).
publish-formAçãofull

Publish a form so it starts collecting signups.

1 argumento
  • id stringobrigatórioForm ID (frm_xxx).
unpublish-formAçãofull

Take a form offline. It stops collecting signups.

1 argumento
  • id stringobrigatórioForm ID (frm_xxx).
reset-form-tokenDestrutivafull

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

1 argumento
  • id stringobrigatórioForm ID (frm_xxx).

Verificação de e-mails verification

verify-emailCriaçãofull

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

2 argumentos
  • email stringobrigatório
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCriaçãofull

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

2 argumentos
  • name stringobrigatório
  • emails string[]obrigatório
list-verification-listsLeiturafull

List bulk verification lists with their progress.

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

Retrieve a verification list with progress and result counts.

1 argumento
  • id stringobrigatórioVerification list ID (evl_xxx).
get-verification-list-resultsLeiturafull

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

5 argumentos
  • id stringobrigatórioVerification 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"

Eventos events

list-eventsLeiturafull

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

4 argumentos
  • 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-eventLeiturafull

Retrieve one event with its full payload.

1 argumento
  • id stringobrigatórioEvent ID (evt_xxx).

Esta página foi útil?

Obrigado pelo feedback.

Obrigado, lemos todas as mensagens.