Saltar al contenido
Docs

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.

Actualizado el 2 oct 2026

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-workspaceLecturasending

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-workspacesLecturasendingSolo 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-workspaceActualizaciónsendingSolo 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 stringobligatorioWorkspace ID or exact name from list-workspaces.
create-workspaceCreaciónfullSolo OAuth

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

1 argumento
  • name stringobligatorioWorkspace name.

Emails emails

send-emailEnvíosending

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[]obligatorioRecipient 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-emailsLecturafull

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-emailLecturafull

Retrieve a single email with its status and delivery details.

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
get-email-rawLecturafull

Return the full raw MIME message of an email.

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
get-email-bodyLecturafull

Return the parsed text and HTML body of an email.

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
get-email-attachmentsLecturafull

Return the attachments of an email.

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
get-email-metaLecturafull

Return email metadata and headers without attachment content.

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
update-emailActualizaciónsending

Change the send time of a scheduled email.

2 argumentos
  • id stringobligatorioEmail ID (em_xxx).
  • scheduled_at stringobligatorioNew send time, ISO 8601.
cancel-emailDestructivasending

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 stringobligatorioEmail ID (em_xxx).
retry-emailEnvíosending

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

1 argumento
  • id stringobligatorioEmail ID (em_xxx).
forward-emailEnvíosending

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 stringobligatorioEmail ID (em_xxx).
  • to string | string[]obligatorioNew 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

Dominios domains

create-domainCreaciónfull

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

7 argumentos
  • name stringobligatorioDomain 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-domainLecturafull

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

1 argumento
  • id stringobligatorioDomain ID.
list-domainsLecturafull

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-domainActualizaciónfull

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

9 argumentos
  • id stringobligatorioDomain 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-domainEliminaciónfullRol de administrador

Permanently delete a domain. Sending from it stops immediately.

1 argumento
  • id stringobligatorioDomain ID.
verify-domainAcciónfull

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

1 argumento
  • id stringobligatorioDomain ID.

DMARC dmarc

list-dmarc-reportsLecturafull

List DMARC aggregate or forensic reports received for a domain.

11 argumentos
  • id stringobligatorioDomain 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-reportLecturafull

Retrieve one DMARC aggregate report with its records.

2 argumentos
  • id stringobligatorioDomain ID.
  • report_id stringobligatorioDMARC report ID.
list-dmarc-forensic-reportsLecturafull

List DMARC forensic (failure) reports for a domain.

5 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
  • limit number
  • offset number
get-dmarc-forensic-reportLecturafull

Retrieve one DMARC forensic report.

2 argumentos
  • id stringobligatorioDomain ID.
  • report_id stringobligatorioForensic report ID.
get-dmarc-statsLecturafull

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

3 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-sourcesLecturafull

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

3 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-countriesLecturafull

DMARC message volume by sending country.

3 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-asnsLecturafull

DMARC message volume by sending network (ASN).

3 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
list-dmarc-reportersLecturafull

Organizations that sent DMARC reports for the domain.

3 argumentos
  • id stringobligatorioDomain ID.
  • from stringStart date, ISO 8601.
  • to stringEnd date, ISO 8601.
upload-dmarc-reportCreaciónfull

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

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

Plantillas templates

create-templateCreaciónfull

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

8 argumentos
  • name stringobligatorio
  • alias stringobligatorioUnique 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-templateLecturafull

Retrieve a template with its content.

1 argumento
  • id stringobligatorioTemplate ID (tem_xxx).
list-templatesLecturafull

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-templateActualizaciónfull

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

9 argumentos
  • id stringobligatorioTemplate 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-templateEliminaciónfull

Permanently delete a template.

1 argumento
  • id stringobligatorioTemplate ID (tem_xxx).
publish-templateAcciónfull

Publish the current template draft so new sends use it.

1 argumento
  • id stringobligatorioTemplate ID (tem_xxx).

Claves de API api_keys

create-api-keyCreaciónfullRol de administrador

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

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

Retrieve an API key (without its secret).

1 argumento
  • id stringobligatorioAPI key ID.
list-api-keysLecturafull

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-keyActualizaciónfullRol de administrador

Rename an API key.

2 argumentos
  • id stringobligatorioAPI key ID.
  • name stringobligatorio
delete-api-keyEliminaciónfullRol de administrador

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

1 argumento
  • id stringobligatorioAPI key ID.
regenerate-api-keyDestructivafullRol de administrador

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

1 argumento
  • id stringobligatorioAPI key ID.

Listas de contactos y suscriptores audiences

create-audienceCreaciónfull

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

1 argumento
  • name stringobligatorio
get-audienceLecturafull

Retrieve an audience with subscriber counts.

1 argumento
  • id stringobligatorioAudience ID.
list-audiencesLecturafull

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-audienceActualizaciónfull

Rename an audience.

2 argumentos
  • id stringobligatorioAudience ID.
  • name stringobligatorio
delete-audienceEliminaciónfull

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

1 argumento
  • id stringobligatorioAudience ID.
list-audience-subscribersLecturafull

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

9 argumentos
  • id stringobligatorioAudience 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-subscriberLecturafull

Retrieve one subscriber of an audience.

2 argumentos
  • id stringobligatorioAudience ID.
  • subscriber_id stringobligatorioSubscriber ID.
add-audience-subscriberCreaciónfull

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

5 argumentos
  • id stringobligatorioAudience ID.
  • email stringobligatorio
  • first_name string
  • last_name string
  • custom_fields object
update-audience-subscriberActualizaciónfull

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

7 argumentos
  • id stringobligatorioAudience ID.
  • subscriber_id stringobligatorioSubscriber ID.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • subscribed boolean
remove-audience-subscriberEliminaciónfull

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

2 argumentos
  • id stringobligatorioAudience ID.
  • subscriber_id stringobligatorioSubscriber ID.

Contactos contacts

create-contactCreaciónfull

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

6 argumentos
  • email stringobligatorio
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]Audience IDs to subscribe to.
  • unsubscribed boolean
get-contactLecturafull

Retrieve a contact by ID or email address.

1 argumento
  • id stringobligatorioContact ID (con_xxx) or email address.
list-contactsLecturafull

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-contactActualizaciónfull

Update a contact. Passing audiences replaces its audience memberships.

7 argumentos
  • id stringobligatorioContact ID (con_xxx) or email address.
  • email string
  • first_name string
  • last_name string
  • custom_fields object
  • audiences string[]
  • unsubscribed boolean
delete-contactEliminaciónfull

Permanently delete a contact and its audience memberships.

1 argumento
  • id stringobligatorioContact ID (con_xxx) or email address.
bulk-update-contactsDestructivafull

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"obligatorio
  • ids string[]obligatorioContact IDs (con_xxx).
  • audience_id stringRequired for add_to_audience and remove_from_audience.
export-contactsLecturafull

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

Direcciones bloqueadas suppressions

create-suppressionCreaciónfull

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

4 argumentos
  • email stringobligatorio
  • 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-suppressionLecturafull

Retrieve a suppression by ID or email address.

1 argumento
  • id stringobligatorioSuppression ID (sup_xxx) or email address.
list-suppressionsLecturafull

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-suppressionActualizaciónfull

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

4 argumentos
  • id stringobligatorioSuppression 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-suppressionEliminaciónfull

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

1 argumento
  • id stringobligatorioSuppression ID (sup_xxx) or email address.

Webhooks webhooks

create-webhookCreaciónfull

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

6 argumentos
  • name stringobligatorio
  • url stringobligatorioHTTPS 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-webhookLecturafull

Retrieve a webhook with its subscribed events and filter.

1 argumento
  • id stringobligatorioWebhook ID (wh_xxx).
list-webhooksLecturafull

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-webhookActualizaciónfull

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

7 argumentos
  • id stringobligatorioWebhook 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-webhookEliminaciónfull

Permanently delete a webhook. Pending deliveries are dropped.

1 argumento
  • id stringobligatorioWebhook 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 stringobligatorioWebhook 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-secretDestructivafull

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

1 argumento
  • id stringobligatorioWebhook ID (wh_xxx).
retry-failed-webhook-requestsAcciónfull

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

1 argumento
  • id stringobligatorioWebhook ID (wh_xxx).
retry-webhook-requestAcciónfull

Queue one webhook delivery for retry.

2 argumentos
  • id stringobligatorioWebhook ID (wh_xxx).
  • request_id stringobligatorioWebhook request ID.

Campañas campaigns

list-campaignsLecturafull

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-campaignLecturafull

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

1 argumento
  • id stringobligatorioCampaign ID (cmp_xxx) or name.
create-campaignCreaciónfull

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

8 argumentos
  • name stringobligatorio
  • 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-campaignActualizaciónfull

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

10 argumentos
  • id stringobligatorioCampaign 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-campaignEliminaciónfull

Permanently delete a campaign that has not been sent.

1 argumento
  • id stringobligatorioCampaign ID (cmp_xxx) or name.
send-campaignEnvíofull

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 stringobligatorioCampaign ID (cmp_xxx) or name.
  • scheduled_at stringFuture send time, ISO 8601 or natural language.
cancel-campaignDestructivafull

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 stringobligatorioCampaign ID (cmp_xxx) or name.

Automatizaciones automations

list-automationsLecturafull

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-automationLecturafull

Retrieve an automation with its steps and connections.

1 argumento
  • id stringobligatorioAutomation ID (aut_xxx).
create-automationCreaciónfull

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"obligatorioWhat the automation runs on.
  • name stringobligatorio
  • description string | null
  • settings object
  • steps object[]obligatorio
  • connections object[]obligatorio
update-automationActualizaciónfull

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

6 argumentos
  • id stringobligatorioAutomation ID (aut_xxx).
  • name string
  • description string
  • settings object
  • steps object[]
  • connections object[]
delete-automationEliminaciónfull

Delete an automation and stop any runs in progress.

1 argumento
  • id stringobligatorioAutomation ID (aut_xxx).
start-automationAcciónfull

Start or resume an automation so new triggers enroll contacts.

1 argumento
  • id stringobligatorioAutomation ID (aut_xxx).
pause-automationAcciónfull

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

1 argumento
  • id stringobligatorioAutomation ID (aut_xxx).
stop-automationAcciónfull

Stop an automation and cancel runs in progress.

1 argumento
  • id stringobligatorioAutomation ID (aut_xxx).
trigger-automationEnvíofull

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

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

List runs of an automation, optionally by status.

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

Retrieve one automation run with its step history.

2 argumentos
  • id stringobligatorioAutomation ID (aut_xxx).
  • run_id stringobligatorioAutomation run ID.
get-automation-statsLecturafull

Return run totals by status and outcome for an automation.

3 argumentos
  • id stringobligatorioAutomation ID (aut_xxx).
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.
get-automation-step-statsLecturafull

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

4 argumentos
  • id stringobligatorioAutomation ID (aut_xxx).
  • step_key stringobligatorioStep key from the automation definition.
  • since stringISO 8601 start time.
  • until stringISO 8601 end time.

Formularios forms

list-formsLecturafull

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-formLecturafull

Retrieve a signup form with its definition and settings.

1 argumento
  • id stringobligatorioForm ID (frm_xxx).
create-formCreaciónfull

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

4 argumentos
  • name stringobligatorio
  • 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-formActualizaciónfull

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

5 argumentos
  • id stringobligatorioForm 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-formEliminaciónfull

Permanently delete a form. Embedded copies stop working.

1 argumento
  • id stringobligatorioForm ID (frm_xxx).
publish-formAcciónfull

Publish a form so it starts collecting signups.

1 argumento
  • id stringobligatorioForm ID (frm_xxx).
unpublish-formAcciónfull

Take a form offline. It stops collecting signups.

1 argumento
  • id stringobligatorioForm ID (frm_xxx).
reset-form-tokenDestructivafull

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

1 argumento
  • id stringobligatorioForm ID (frm_xxx).

Verificación de emails verification

verify-emailCreaciónfull

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

2 argumentos
  • email stringobligatorio
  • mode "fast" | "full"fast: DNS and syntax checks. full: adds an SMTP mailbox check.
create-verification-listCreaciónfull

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

2 argumentos
  • name stringobligatorio
  • emails string[]obligatorio
list-verification-listsLecturafull

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-listLecturafull

Retrieve a verification list with progress and result counts.

1 argumento
  • id stringobligatorioVerification list ID (evl_xxx).
get-verification-list-resultsLecturafull

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

5 argumentos
  • id stringobligatorioVerification 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-eventsLecturafull

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-eventLecturafull

Retrieve one event with its full payload.

1 argumento
  • id stringobligatorioEvent ID (evt_xxx).

¿Te ha resultado útil esta página?

Gracias por tu opinión.

Gracias. Leemos todos los mensajes.