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.
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-workspaceLeiturasendingReturn 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 OAuthList the workspaces this connection may use, with your role in each. Pass a workspace ID or name as `workspace` to any tool to act in it.
switch-workspaceAtualizaçãosendingApenas OAuthChange the default workspace for later tool calls on this connection. To act in another workspace for a single call, pass `workspace` to that tool instead.
1 argumento
workspace_idstringobrigatórioWorkspace ID or exact name from list-workspaces.
create-workspaceCriaçãofullApenas OAuthCreate a new workspace, give this connection access to it, and switch to it.
1 argumento
namestringobrigatórioWorkspace name.
E-mails emails
send-emailEnviosendingSend 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
fromstringSender in RFC format, e.g. "Acme <hello@mail.acme.com>". Must use a verified domain.tostring | string[]obrigatórioRecipient 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-emailsLeiturafullList sent and received emails with pagination, status, recipient, sender, subject, domain, API key, and date filters.
16 argumentos
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-emailLeiturafullRetrieve a single email with its status and delivery details.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
get-email-rawLeiturafullReturn the full raw MIME message of an email.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
get-email-bodyLeiturafullReturn the parsed text and HTML body of an email.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
get-email-attachmentsLeiturafullReturn the attachments of an email.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
get-email-metaLeiturafullReturn email metadata and headers without attachment content.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
update-emailAtualizaçãosendingChange the send time of a scheduled email.
2 argumentos
idstringobrigatórioEmail ID (em_xxx).scheduled_atstringobrigatórioNew send time, ISO 8601.
cancel-emailDestrutivasendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
retry-emailEnviosendingRetry delivery of a failed, errored, or held email to its original recipients.
1 argumento
idstringobrigatórioEmail ID (em_xxx).
forward-emailEnviosendingForward 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
idstringobrigatórioEmail ID (em_xxx).tostring | string[]obrigatórioNew 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
Domínios domains
create-domainCriaçãofullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 argumentos
namestringobrigatórioDomain 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-domainLeiturafullRetrieve a domain with its DNS records and per-record verification status.
1 argumento
idstringobrigatórioDomain ID.
list-domainsLeiturafullList sending domains in the workspace.
7 argumentos
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-domainAtualizaçãofullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 argumentos
idstringobrigatórioDomain 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-domainExclusãofullPapel AdminPermanently delete a domain. Sending from it stops immediately.
1 argumento
idstringobrigatórioDomain ID.
verify-domainAçãofullRun a DNS check now and update the verification status of each record.
1 argumento
idstringobrigatórioDomain ID.
DMARC dmarc
list-dmarc-reportsLeiturafullList DMARC aggregate or forensic reports received for a domain.
11 argumentos
idstringobrigatórioDomain 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-reportLeiturafullRetrieve one DMARC aggregate report with its records.
2 argumentos
idstringobrigatórioDomain ID.report_idstringobrigatórioDMARC report ID.
list-dmarc-forensic-reportsLeiturafullList DMARC forensic (failure) reports for a domain.
5 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportLeiturafullRetrieve one DMARC forensic report.
2 argumentos
idstringobrigatórioDomain ID.report_idstringobrigatórioForensic report ID.
get-dmarc-statsLeiturafullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesLeiturafullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesLeiturafullDMARC message volume by sending country.
3 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsLeiturafullDMARC message volume by sending network (ASN).
3 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersLeiturafullOrganizations that sent DMARC reports for the domain.
3 argumentos
idstringobrigatórioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportCriaçãofullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 argumentos
idstringobrigatórioDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Templates templates
create-templateCriaçãofullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 argumentos
namestringobrigatórioaliasstringobrigatórioUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateLeiturafullRetrieve a template with its content.
1 argumento
idstringobrigatórioTemplate ID (tem_xxx).
list-templatesLeiturafullList templates in the workspace.
7 argumentos
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-templateAtualizaçãofullUpdate a template draft. Publish it to make the change live.
9 argumentos
idstringobrigatórioTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateExclusãofullPermanently delete a template.
1 argumento
idstringobrigatórioTemplate ID (tem_xxx).
publish-templateAçãofullPublish the current template draft so new sends use it.
1 argumento
idstringobrigatórioTemplate ID (tem_xxx).
Chaves de API api_keys
create-api-keyCriaçãofullPapel AdminCreate an API key. The secret is returned only once; tell the user to store it securely.
3 argumentos
namestringobrigatórioscope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyLeiturafullRetrieve an API key (without its secret).
1 argumento
idstringobrigatórioAPI key ID.
list-api-keysLeiturafullList API keys in the workspace.
7 argumentos
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-keyAtualizaçãofullPapel AdminRename an API key.
2 argumentos
idstringobrigatórioAPI key ID.namestringobrigatório
delete-api-keyExclusãofullPapel AdminPermanently revoke an API key. Apps using it stop working immediately.
1 argumento
idstringobrigatórioAPI key ID.
regenerate-api-keyDestrutivafullPapel AdminIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 argumento
idstringobrigatórioAPI key ID.
Listas e inscritos audiences
create-audienceCriaçãofullCreate an audience (mailing list) for campaigns and automations.
1 argumento
namestringobrigatório
get-audienceLeiturafullRetrieve an audience with subscriber counts.
1 argumento
idstringobrigatórioAudience ID.
list-audiencesLeiturafullList audiences in the workspace.
7 argumentos
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-audienceAtualizaçãofullRename an audience.
2 argumentos
idstringobrigatórioAudience ID.namestringobrigatório
delete-audienceExclusãofullPermanently delete an audience and its subscriber records. Contacts are kept.
1 argumento
idstringobrigatórioAudience ID.
list-audience-subscribersLeiturafullList subscribers of an audience, optionally only subscribed or unsubscribed.
9 argumentos
idstringobrigatórioAudience 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-subscriberLeiturafullRetrieve one subscriber of an audience.
2 argumentos
idstringobrigatórioAudience ID.subscriber_idstringobrigatórioSubscriber ID.
add-audience-subscriberCriaçãofullAdd an email address to an audience. Creates the contact if it does not exist.
5 argumentos
idstringobrigatórioAudience ID.emailstringobrigatóriofirst_namestringlast_namestringcustom_fieldsobject
update-audience-subscriberAtualizaçãofullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 argumentos
idstringobrigatórioAudience ID.subscriber_idstringobrigatórioSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberExclusãofullRemove a subscriber from an audience. The contact is kept.
2 argumentos
idstringobrigatórioAudience ID.subscriber_idstringobrigatórioSubscriber ID.
Contatos contacts
create-contactCriaçãofullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 argumentos
emailstringobrigatóriofirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
get-contactLeiturafullRetrieve a contact by ID or email address.
1 argumento
idstringobrigatórioContact ID (con_xxx) or email address.
list-contactsLeiturafullList contacts with search, audience, subscription, and custom-field filters.
9 argumentos
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-contactAtualizaçãofullUpdate a contact. Passing audiences replaces its audience memberships.
7 argumentos
idstringobrigatórioContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactExclusãofullPermanently delete a contact and its audience memberships.
1 argumento
idstringobrigatórioContact ID (con_xxx) or email address.
bulk-update-contactsDestrutivafullApply 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órioidsstring[]obrigatórioContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsLeiturafullExport contacts matching the filters as CSV text (email, names, subscription, audiences, custom fields).
9 argumentos
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
Supressões suppressions
create-suppressionCriaçãofullAdd an email address to the suppression list so Emailit never sends to it.
4 argumentos
emailstringobrigatóriotype"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-suppressionLeiturafullRetrieve a suppression by ID or email address.
1 argumento
idstringobrigatórioSuppression ID (sup_xxx) or email address.
list-suppressionsLeiturafullList suppressed addresses with search, type, reason, and expiry filters.
7 argumentos
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-suppressionAtualizaçãofullChange the type, reason, or expiry of a suppression.
4 argumentos
idstringobrigatórioSuppression 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-suppressionExclusãofullRemove an address from the suppression list so it can receive email again.
1 argumento
idstringobrigatórioSuppression ID (sup_xxx) or email address.
Webhooks webhooks
create-webhookCriaçãofullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 argumentos
namestringobrigatóriourlstringobrigatórioHTTPS 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-webhookLeiturafullRetrieve a webhook with its subscribed events and filter.
1 argumento
idstringobrigatórioWebhook ID (wh_xxx).
list-webhooksLeiturafullList webhooks in the workspace.
7 argumentos
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-webhookAtualizaçãofullUpdate a webhook URL, name, events, filter, or enable it again.
7 argumentos
idstringobrigatórioWebhook 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-webhookExclusãofullPermanently delete a webhook. Pending deliveries are dropped.
1 argumento
idstringobrigatórioWebhook ID (wh_xxx).
test-webhookExternafullSend a sample event of the given type to the webhook URL and return the response. Limited to 5 per minute.
2 argumentos
idstringobrigató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-secretDestrutivafullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 argumento
idstringobrigatórioWebhook ID (wh_xxx).
retry-failed-webhook-requestsAçãofullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 argumento
idstringobrigatórioWebhook ID (wh_xxx).
retry-webhook-requestAçãofullQueue one webhook delivery for retry.
2 argumentos
idstringobrigatórioWebhook ID (wh_xxx).request_idstringobrigatórioWebhook request ID.
Campanhas campaigns
list-campaignsLeiturafullList marketing campaigns, optionally by status.
4 argumentos
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).searchstringSearch by name or subject.status"all" | "draft" | "scheduled" | "sending" | "sent" | "archived"
get-campaignLeiturafullRetrieve a campaign with its content, recipients, and stats.
1 argumento
idstringobrigatórioCampaign ID (cmp_xxx) or name.
create-campaignCriaçãofullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
8 argumentos
namestringobrigatóriosubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignAtualizaçãofullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 argumentos
idstringobrigatórioCampaign 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-campaignExclusãofullPermanently delete a campaign that has not been sent.
1 argumento
idstringobrigatórioCampaign ID (cmp_xxx) or name.
send-campaignEnviofullSend a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.
2 argumentos
idstringobrigatórioCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
cancel-campaignDestrutivafullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 argumento
idstringobrigatórioCampaign ID (cmp_xxx) or name.
Automações automations
list-automationsLeiturafullList automations with context, status, and name filters.
7 argumentos
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-automationLeiturafullRetrieve an automation with its steps and connections.
1 argumento
idstringobrigatórioAutomation ID (aut_xxx).
create-automationCriaçãofullCreate 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.namestringobrigatóriodescriptionstring | nullsettingsobjectstepsobject[]obrigatórioconnectionsobject[]obrigatório
update-automationAtualizaçãofullUpdate an automation. Passing steps or connections replaces the whole graph.
6 argumentos
idstringobrigatórioAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationExclusãofullDelete an automation and stop any runs in progress.
1 argumento
idstringobrigatórioAutomation ID (aut_xxx).
start-automationAçãofullStart or resume an automation so new triggers enroll contacts.
1 argumento
idstringobrigatórioAutomation ID (aut_xxx).
pause-automationAçãofullPause an automation. Runs in progress wait until it is started again.
1 argumento
idstringobrigatórioAutomation ID (aut_xxx).
stop-automationAçãofullStop an automation and cancel runs in progress.
1 argumento
idstringobrigatórioAutomation ID (aut_xxx).
trigger-automationEnviofullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 argumentos
idstringobrigatórioAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLeiturafullList runs of an automation, optionally by status.
4 argumentos
idstringobrigatórioAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLeiturafullRetrieve one automation run with its step history.
2 argumentos
idstringobrigatórioAutomation ID (aut_xxx).run_idstringobrigatórioAutomation run ID.
get-automation-statsLeiturafullReturn run totals by status and outcome for an automation.
3 argumentos
idstringobrigatórioAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsLeiturafullReturn totals for one step, including the delivery funnel for send_email steps.
4 argumentos
idstringobrigatórioAutomation ID (aut_xxx).step_keystringobrigatórioStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Formulários forms
list-formsLeiturafullList signup forms with name, type, and status filters.
7 argumentos
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-formLeiturafullRetrieve a signup form with its definition and settings.
1 argumento
idstringobrigatórioForm ID (frm_xxx).
create-formCriaçãofullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 argumentos
namestringobrigatóriotype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formAtualizaçãofullUpdate a form name, type, definition, or settings.
5 argumentos
idstringobrigatórioForm 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-formExclusãofullPermanently delete a form. Embedded copies stop working.
1 argumento
idstringobrigatórioForm ID (frm_xxx).
publish-formAçãofullPublish a form so it starts collecting signups.
1 argumento
idstringobrigatórioForm ID (frm_xxx).
unpublish-formAçãofullTake a form offline. It stops collecting signups.
1 argumento
idstringobrigatórioForm ID (frm_xxx).
reset-form-tokenDestrutivafullRotate the public form token. Existing embed codes stop working until updated.
1 argumento
idstringobrigatórioForm ID (frm_xxx).
Verificação de e-mails verification
verify-emailCriaçãofullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 argumentos
emailstringobrigatóriomode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCriaçãofullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
2 argumentos
namestringobrigatórioemailsstring[]obrigatório
list-verification-listsLeiturafullList bulk verification lists with their progress.
4 argumentos
pagenumberPage number (default: 1).limitnumberResults per page (max: 100).status"pending" | "processing" | "completed" | "failed" | "canceled"searchstring
get-verification-listLeiturafullRetrieve a verification list with progress and result counts.
1 argumento
idstringobrigatórioVerification list ID (evl_xxx).
get-verification-list-resultsLeiturafullReturn per-address results of a verification list, optionally by status or result.
5 argumentos
idstringobrigatórioVerification 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"
Eventos events
list-eventsLeiturafullList workspace events (email delivered, bounced, clicked, contact created, and more), newest first.
4 argumentos
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-eventLeiturafullRetrieve one event with its full payload.
1 argumento
idstringobrigatórioEvent ID (evt_xxx).