Referencia
Referencia de herramientas MCP
Todas las herramientas del servidor MCP alojado de Emailit, agrupadas por conjunto de herramientas, con su tipo, el permiso necesario, el rol requerido y sus argumentos.
El servidor alojado en https://api.emailit.com/mcp expone 109 herramientas en 15 conjuntos de herramientas. Esta referencia se genera a partir del catálogo de herramientas del servidor, así que siempre coincide con lo que ve tu asistente. Las descripciones de las herramientas y de los argumentos se muestran tal como las envía el servidor, en inglés.
Permiso. Las herramientas con el permiso sending también funcionan con full. Consulta Espacios de trabajo y permisos.
Tipo. Lectura: no hace cambios. Creación y Actualización: modifican datos. Acción: cambia un estado. Eliminación: borra datos. Destructiva: no se puede deshacer. Externa: llama a una URL tuya. Envío: llega a destinatarios reales. Los tipos corresponden a las anotaciones de herramientas de MCP (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), para que los clientes puedan pedir confirmación antes de ejecutar herramientas de escritura.
Espacio de trabajo. Con OAuth, todas las herramientas que no pertenecen al conjunto de herramientas de espacios de trabajo aceptan también un argumento opcional workspace (ID o nombre exacto) para ejecutar esa llamada en otro espacio de trabajo permitido. Las herramientas marcadas con Rol de administrador se rechazan con admin_role_required cuando las llama un miembro (Member) del espacio de trabajo. Las conexiones con clave de API no tienen argumento workspace ni limitaciones de rol.
Resultados. Las herramientas devuelven JSON como texto para todos los clientes y como structuredContent para los clientes que leen resultados estructurados. Las herramientas de listado aceptan page, limit y filtros estructurados ({ field, condition, value }).
Espacio de trabajo workspace
get-current-workspaceLecturasendingReturn 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-workspacesLecturasendingSolo 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-workspaceActualizaciónsendingSolo 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_idstringobligatorioWorkspace ID or exact name from list-workspaces.
create-workspaceCreaciónfullSolo OAuthCreate a new workspace, give this connection access to it, and switch to it.
1 argumento
namestringobligatorioWorkspace name.
Emails emails
send-emailEnvíosendingSend 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[]obligatorioRecipient 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-emailsLecturafullList 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-emailLecturafullRetrieve a single email with its status and delivery details.
1 argumento
idstringobligatorioEmail ID (em_xxx).
get-email-rawLecturafullReturn the full raw MIME message of an email.
1 argumento
idstringobligatorioEmail ID (em_xxx).
get-email-bodyLecturafullReturn the parsed text and HTML body of an email.
1 argumento
idstringobligatorioEmail ID (em_xxx).
get-email-attachmentsLecturafullReturn the attachments of an email.
1 argumento
idstringobligatorioEmail ID (em_xxx).
get-email-metaLecturafullReturn email metadata and headers without attachment content.
1 argumento
idstringobligatorioEmail ID (em_xxx).
update-emailActualizaciónsendingChange the send time of a scheduled email.
2 argumentos
idstringobligatorioEmail ID (em_xxx).scheduled_atstringobligatorioNew send time, ISO 8601.
cancel-emailDestructivasendingBest-effort cancel of a scheduled, accepted, or attempted email. Pulls it from the send queue; not guaranteed if delivery already started.
1 argumento
idstringobligatorioEmail ID (em_xxx).
retry-emailEnvíosendingRetry delivery of a failed, errored, or held email to its original recipients.
1 argumento
idstringobligatorioEmail ID (em_xxx).
forward-emailEnvíosendingForward 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
idstringobligatorioEmail ID (em_xxx).tostring | string[]obligatorioNew 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
Dominios domains
create-domainCreaciónfullAdd a sending domain. Returns the SPF, DKIM, return-path, and DMARC DNS records to publish before verifying.
7 argumentos
namestringobligatorioDomain 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-domainLecturafullRetrieve a domain with its DNS records and per-record verification status.
1 argumento
idstringobligatorioDomain ID.
list-domainsLecturafullList 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-domainActualizaciónfullUpdate domain settings such as open/click tracking, inbound, or DMARC report collection.
9 argumentos
idstringobligatorioDomain 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-domainEliminaciónfullRol de administradorPermanently delete a domain. Sending from it stops immediately.
1 argumento
idstringobligatorioDomain ID.
verify-domainAcciónfullRun a DNS check now and update the verification status of each record.
1 argumento
idstringobligatorioDomain ID.
DMARC dmarc
list-dmarc-reportsLecturafullList DMARC aggregate or forensic reports received for a domain.
11 argumentos
idstringobligatorioDomain 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-reportLecturafullRetrieve one DMARC aggregate report with its records.
2 argumentos
idstringobligatorioDomain ID.report_idstringobligatorioDMARC report ID.
list-dmarc-forensic-reportsLecturafullList DMARC forensic (failure) reports for a domain.
5 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.limitnumberoffsetnumber
get-dmarc-forensic-reportLecturafullRetrieve one DMARC forensic report.
2 argumentos
idstringobligatorioDomain ID.report_idstringobligatorioForensic report ID.
get-dmarc-statsLecturafullDMARC pass/fail totals and alignment rates for a domain over a date range.
3 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-sourcesLecturafullSending sources (IPs and hostnames) seen in DMARC reports, with pass/fail counts.
3 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-countriesLecturafullDMARC message volume by sending country.
3 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-asnsLecturafullDMARC message volume by sending network (ASN).
3 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
list-dmarc-reportersLecturafullOrganizations that sent DMARC reports for the domain.
3 argumentos
idstringobligatorioDomain ID.fromstringStart date, ISO 8601.tostringEnd date, ISO 8601.
upload-dmarc-reportCreaciónfullImport a DMARC aggregate report (XML, or base64 of a .xml/.gz/.zip file) for a domain.
4 argumentos
idstringobligatorioDomain ID.contentstringRaw report XML.content_base64stringBase64 of the report file.filenamestring
Plantillas templates
create-templateCreaciónfullCreate an email template. Reference it from send-email by ID or alias; publish it before use.
8 argumentos
namestringobligatorioaliasstringobligatorioUnique slug used by send-email.fromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
get-templateLecturafullRetrieve a template with its content.
1 argumento
idstringobligatorioTemplate ID (tem_xxx).
list-templatesLecturafullList 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-templateActualizaciónfullUpdate a template draft. Publish it to make the change live.
9 argumentos
idstringobligatorioTemplate ID (tem_xxx).namestringaliasstringfromstringDefault sender.subjectstringSubject; supports {{variables}}.reply_tostring | string[]htmlstringHTML body; supports {{variables}}.textstringeditor"html" | "text" | "dragit" | "tiptap"
delete-templateEliminaciónfullPermanently delete a template.
1 argumento
idstringobligatorioTemplate ID (tem_xxx).
publish-templateAcciónfullPublish the current template draft so new sends use it.
1 argumento
idstringobligatorioTemplate ID (tem_xxx).
Claves de API api_keys
create-api-keyCreaciónfullRol de administradorCreate an API key. The secret is returned only once; tell the user to store it securely.
3 argumentos
namestringobligatorioscope"full" | "sending"sending = send-only, full = every endpoint.sending_domain_idstring | nullLock a sending key to one domain.
get-api-keyLecturafullRetrieve an API key (without its secret).
1 argumento
idstringobligatorioAPI key ID.
list-api-keysLecturafullList 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-keyActualizaciónfullRol de administradorRename an API key.
2 argumentos
idstringobligatorioAPI key ID.namestringobligatorio
delete-api-keyEliminaciónfullRol de administradorPermanently revoke an API key. Apps using it stop working immediately.
1 argumento
idstringobligatorioAPI key ID.
regenerate-api-keyDestructivafullRol de administradorIssue a new secret for an API key and invalidate the old one immediately. The new secret is returned only once.
1 argumento
idstringobligatorioAPI key ID.
Listas de contactos y suscriptores audiences
create-audienceCreaciónfullCreate an audience (mailing list) for campaigns and automations.
1 argumento
namestringobligatorio
get-audienceLecturafullRetrieve an audience with subscriber counts.
1 argumento
idstringobligatorioAudience ID.
list-audiencesLecturafullList 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-audienceActualizaciónfullRename an audience.
2 argumentos
idstringobligatorioAudience ID.namestringobligatorio
delete-audienceEliminaciónfullPermanently delete an audience and its subscriber records. Contacts are kept.
1 argumento
idstringobligatorioAudience ID.
list-audience-subscribersLecturafullList subscribers of an audience, optionally only subscribed or unsubscribed.
9 argumentos
idstringobligatorioAudience 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-subscriberLecturafullRetrieve one subscriber of an audience.
2 argumentos
idstringobligatorioAudience ID.subscriber_idstringobligatorioSubscriber ID.
add-audience-subscriberCreaciónfullAdd an email address to an audience. Creates the contact if it does not exist.
5 argumentos
idstringobligatorioAudience ID.emailstringobligatoriofirst_namestringlast_namestringcustom_fieldsobject
update-audience-subscriberActualizaciónfullUpdate a subscriber, including subscribing or unsubscribing them from the audience.
7 argumentos
idstringobligatorioAudience ID.subscriber_idstringobligatorioSubscriber ID.emailstringfirst_namestringlast_namestringcustom_fieldsobjectsubscribedboolean
remove-audience-subscriberEliminaciónfullRemove a subscriber from an audience. The contact is kept.
2 argumentos
idstringobligatorioAudience ID.subscriber_idstringobligatorioSubscriber ID.
Contactos contacts
create-contactCreaciónfullCreate a contact, optionally subscribing it to audiences and setting custom fields.
6 argumentos
emailstringobligatoriofirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]Audience IDs to subscribe to.unsubscribedboolean
get-contactLecturafullRetrieve a contact by ID or email address.
1 argumento
idstringobligatorioContact ID (con_xxx) or email address.
list-contactsLecturafullList 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-contactActualizaciónfullUpdate a contact. Passing audiences replaces its audience memberships.
7 argumentos
idstringobligatorioContact ID (con_xxx) or email address.emailstringfirst_namestringlast_namestringcustom_fieldsobjectaudiencesstring[]unsubscribedboolean
delete-contactEliminaciónfullPermanently delete a contact and its audience memberships.
1 argumento
idstringobligatorioContact ID (con_xxx) or email address.
bulk-update-contactsDestructivafullApply 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"obligatorioidsstring[]obligatorioContact IDs (con_xxx).audience_idstringRequired for add_to_audience and remove_from_audience.
export-contactsLecturafullExport 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
Direcciones bloqueadas suppressions
create-suppressionCreaciónfullAdd an email address to the suppression list so Emailit never sends to it.
4 argumentos
emailstringobligatoriotype"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-suppressionLecturafullRetrieve a suppression by ID or email address.
1 argumento
idstringobligatorioSuppression ID (sup_xxx) or email address.
list-suppressionsLecturafullList 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-suppressionActualizaciónfullChange the type, reason, or expiry of a suppression.
4 argumentos
idstringobligatorioSuppression 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-suppressionEliminaciónfullRemove an address from the suppression list so it can receive email again.
1 argumento
idstringobligatorioSuppression ID (sup_xxx) or email address.
Webhooks webhooks
create-webhookCreaciónfullCreate a webhook endpoint for email, domain, contact, and campaign events. The response includes the signing secret.
6 argumentos
namestringobligatoriourlstringobligatorioHTTPS 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-webhookLecturafullRetrieve a webhook with its subscribed events and filter.
1 argumento
idstringobligatorioWebhook ID (wh_xxx).
list-webhooksLecturafullList 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-webhookActualizaciónfullUpdate a webhook URL, name, events, filter, or enable it again.
7 argumentos
idstringobligatorioWebhook 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-webhookEliminaciónfullPermanently delete a webhook. Pending deliveries are dropped.
1 argumento
idstringobligatorioWebhook 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
idstringobligatorioWebhook 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"obligatorioEvent type to send, e.g. email.delivered.
reset-webhook-secretDestructivafullRotate the webhook signing secret. The old secret stops working immediately; the new one is returned once.
1 argumento
idstringobligatorioWebhook ID (wh_xxx).
retry-failed-webhook-requestsAcciónfullQueue every failed delivery of a webhook for retry and re-enable the webhook.
1 argumento
idstringobligatorioWebhook ID (wh_xxx).
retry-webhook-requestAcciónfullQueue one webhook delivery for retry.
2 argumentos
idstringobligatorioWebhook ID (wh_xxx).request_idstringobligatorioWebhook request ID.
Campañas campaigns
list-campaignsLecturafullList 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-campaignLecturafullRetrieve a campaign with its content, recipients, and stats.
1 argumento
idstringobligatorioCampaign ID (cmp_xxx) or name.
create-campaignCreaciónfullCreate a draft campaign. Add recipients with update-campaign, then send with send-campaign.
8 argumentos
namestringobligatoriosubjectstringfrom_emailstringSender address on a verified domain.from_namestringreply_tostringpreview_textstringInbox preview text.contentstringCampaign body in content_type format.content_type"html" | "text" | "mjml"
update-campaignActualizaciónfullUpdate a draft campaign. Passing recipients replaces the audience list; at least one audience must be included.
10 argumentos
idstringobligatorioCampaign 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-campaignEliminaciónfullPermanently delete a campaign that has not been sent.
1 argumento
idstringobligatorioCampaign ID (cmp_xxx) or name.
send-campaignEnvíofullSend a campaign to its audiences now, or schedule it with scheduled_at. Delivers to real subscribers, so confirm with the user first.
2 argumentos
idstringobligatorioCampaign ID (cmp_xxx) or name.scheduled_atstringFuture send time, ISO 8601 or natural language.
cancel-campaignDestructivafullCancel a draft or sending campaign. Scheduled campaigns cannot be canceled; delete them to stop the send. Emails already delivered are not recalled.
1 argumento
idstringobligatorioCampaign ID (cmp_xxx) or name.
Automatizaciones automations
list-automationsLecturafullList 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-automationLecturafullRetrieve an automation with its steps and connections.
1 argumento
idstringobligatorioAutomation ID (aut_xxx).
create-automationCreaciónfullCreate 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"obligatorioWhat the automation runs on.namestringobligatoriodescriptionstring | nullsettingsobjectstepsobject[]obligatorioconnectionsobject[]obligatorio
update-automationActualizaciónfullUpdate an automation. Passing steps or connections replaces the whole graph.
6 argumentos
idstringobligatorioAutomation ID (aut_xxx).namestringdescriptionstringsettingsobjectstepsobject[]connectionsobject[]
delete-automationEliminaciónfullDelete an automation and stop any runs in progress.
1 argumento
idstringobligatorioAutomation ID (aut_xxx).
start-automationAcciónfullStart or resume an automation so new triggers enroll contacts.
1 argumento
idstringobligatorioAutomation ID (aut_xxx).
pause-automationAcciónfullPause an automation. Runs in progress wait until it is started again.
1 argumento
idstringobligatorioAutomation ID (aut_xxx).
stop-automationAcciónfullStop an automation and cancel runs in progress.
1 argumento
idstringobligatorioAutomation ID (aut_xxx).
trigger-automationEnvíofullManually trigger a running automation with an optional payload. Its steps may send real emails.
2 argumentos
idstringobligatorioAutomation ID (aut_xxx).payloadobjectTrigger data, e.g. { "email": "jane@example.com" }.
list-automation-runsLecturafullList runs of an automation, optionally by status.
4 argumentos
idstringobligatorioAutomation ID (aut_xxx).pagenumberPage number (default: 1).per_pagenumberResults per page (max: 100).status"running" | "completed" | "failed" | "skipped" | "canceled" | "paused"
get-automation-runLecturafullRetrieve one automation run with its step history.
2 argumentos
idstringobligatorioAutomation ID (aut_xxx).run_idstringobligatorioAutomation run ID.
get-automation-statsLecturafullReturn run totals by status and outcome for an automation.
3 argumentos
idstringobligatorioAutomation ID (aut_xxx).sincestringISO 8601 start time.untilstringISO 8601 end time.
get-automation-step-statsLecturafullReturn totals for one step, including the delivery funnel for send_email steps.
4 argumentos
idstringobligatorioAutomation ID (aut_xxx).step_keystringobligatorioStep key from the automation definition.sincestringISO 8601 start time.untilstringISO 8601 end time.
Formularios forms
list-formsLecturafullList 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-formLecturafullRetrieve a signup form with its definition and settings.
1 argumento
idstringobligatorioForm ID (frm_xxx).
create-formCreaciónfullCreate a draft signup form (popup, full page, flyout, embed, or banner).
4 argumentos
namestringobligatoriotype"popup" | "full_page" | "flyout" | "embed" | "banner"definitionobjectForm steps and fields. Omit on create to start from the default template.settingsobjectDisplay and audience settings.
update-formActualizaciónfullUpdate a form name, type, definition, or settings.
5 argumentos
idstringobligatorioForm 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-formEliminaciónfullPermanently delete a form. Embedded copies stop working.
1 argumento
idstringobligatorioForm ID (frm_xxx).
publish-formAcciónfullPublish a form so it starts collecting signups.
1 argumento
idstringobligatorioForm ID (frm_xxx).
unpublish-formAcciónfullTake a form offline. It stops collecting signups.
1 argumento
idstringobligatorioForm ID (frm_xxx).
reset-form-tokenDestructivafullRotate the public form token. Existing embed codes stop working until updated.
1 argumento
idstringobligatorioForm ID (frm_xxx).
Verificación de emails verification
verify-emailCreaciónfullCheck whether one address is deliverable (syntax, MX, disposable, role, and optional SMTP checks). Uses verification credits.
2 argumentos
emailstringobligatoriomode"fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCreaciónfullVerify up to 10,000 addresses in the background. Uses one verification credit per address; poll get-verification-list for progress.
2 argumentos
namestringobligatorioemailsstring[]obligatorio
list-verification-listsLecturafullList 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-listLecturafullRetrieve a verification list with progress and result counts.
1 argumento
idstringobligatorioVerification list ID (evl_xxx).
get-verification-list-resultsLecturafullReturn per-address results of a verification list, optionally by status or result.
5 argumentos
idstringobligatorioVerification 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-eventsLecturafullList 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-eventLecturafullRetrieve one event with its full payload.
1 argumento
idstringobligatorioEvent ID (evt_xxx).