Menú

Referencia de la API · Email Marketing

Supresiones

email_marketing · suppressions · 3 operaciones

GET/v1/email-marketing/suppressions

List the suppression list

email_marketing.suppressions.list

LecturaIdempotenteDesde 2026-11-01

Lists the addresses this organization never emails (campaigns and flows skip them), newest first, paginated by cursor: email, reason (unsubscribe: the person clicked the unsubscribe link; hard_bounce and complaint: reported by Amazon SES; manual: added by someone) and source. Filter by reason (applies to the page read: follow next_cursor until has_more is false). Requires view access to Email Marketing.

Alcance
email_marketing:read
Permiso
Ver el módulo
Tool del MCP
email_marketing_suppressions_listEn la superficie completa; en la compacta, mb_execute_operation con id: "email_marketing.suppressions.list".

Costo declarado: hasta 202 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Por defecto: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

reasonenumqueryopcional

Only this reason: unsubscribe, hard_bounce, complaint or manual.

Valores: unsubscribe, hard_bounce, complaint, manual

Respuesta

dataarray<object>
has_moreboolean
next_cursorstring

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/email-marketing/suppressions" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/email-marketing/suppressions" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/email-marketing/suppressions

Add an address to the suppression list

email_marketing.suppressions.add

EscrituraIdempotenteDesde 2026-11-01

Stops every email (campaigns and flows) to an address in this organization; flows drop its pending enrollments when they reach it. Use it to honor an unsubscribe request received by other means (reason unsubscribe) or to block an address (manual, the default). Idempotent: an address already on the list keeps its original reason (created false). An unsubscribe added by mistake can be undone only by the same credential, within an hour (email_marketing.suppressions.remove); after that, only the person can opt back in. Error: email_invalid. Requires full access to Email Marketing.

Alcance
email_marketing:write
Permiso
Editar en el módulo
Tool del MCP
email_marketing_suppressions_addEn la superficie completa; en la compacta, mb_execute_operation con id: "email_marketing.suppressions.add".

Costo declarado: hasta 1 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

emailstringcuerporequerido

The address that must not get marketing emails any more.

reasonenumcuerpoopcional

manual (default), unsubscribe, hard_bounce or complaint.

Valores: unsubscribe, hard_bounce, complaint, manual · Por defecto: "manual"

Respuesta

emailstring
reasonstring
createdboolean

Errores

Ejemplo

curl -X POST "https://api.mb-suite.com/v1/email-marketing/suppressions" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "email": "ana@example.com"
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X POST "https://api.mb-suite.com/v1/email-marketing/suppressions" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "email": "ana@example.com"
}'
DELETE/v1/email-marketing/suppressions/{email}

Remove an address from the suppression list

email_marketing.suppressions.remove

IrreversibleDesde 2026-11-01

Lets an address receive emails again. With an API key or an app only manual and hard_bounce entries can be removed: an address that unsubscribed or complained can only come back by opting in again itself (suppression_compliance_locked), except an unsubscribe that the same credential added through the API less than an hour ago (to undo its own mistake). It is not kept in the trash: add the address again if it was a mistake. Outside the screen it requires a dry run (it runs the same check, so a locked address fails there and gets no confirm_token) and a confirm_token. Not found (email_suppression_not_found) if the address is not on the list. Owners and admins only.

Pide confirmación: primero dry_run: true (vista previa y confirm_token, que vale 10 minutos y una sola vez), después el mismo cuerpo con confirm_token. En unas pocas, solo con ciertos datos: la descripción dice cuándo. Por qué y cómo: Vista previa y confirmación.

Alcance
email_marketing:write y «Permitir eliminar» (email_marketing:delete en OAuth)
Permiso
Editar en el módulo · Solo owner, admin
Tool del MCP
email_marketing_suppressions_removeEn la superficie completa; en la compacta, mb_execute_operation con id: "email_marketing.suppressions.remove".

Costo declarado: hasta 1 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

emailstringrutarequerido

The suppressed address (from email_marketing.suppressions.list).

Respuesta

oktrue

Errores

Ejemplo

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/suppressions/{email}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/email-marketing/suppressions/{email}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'