Supressões

List the suppression list

email_marketing.suppressions.list

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.

Escopo

email_marketing:read

Permissão

Ver o módulo

Tool do MCP

email_marketing_suppressions_listNa superfície completa; na compacta, mb_execute_operation com id: "email_marketing.suppressions.list".

Custo declarado: até 202 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

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

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

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

Add an address to the suppression list

email_marketing.suppressions.add

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.

Escopo

email_marketing:write

Permissão

Editar no módulo

Tool do MCP

email_marketing_suppressions_addNa superfície completa; na compacta, mb_execute_operation com id: "email_marketing.suppressions.add".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

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"
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode 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"
}'

Remove an address from the suppression list

email_marketing.suppressions.remove

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.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo

email_marketing:write e «Permitir exclusões» (email_marketing:delete no OAuth)

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

email_marketing_suppressions_removeNa superfície completa; na compacta, mb_execute_operation com id: "email_marketing.suppressions.remove".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

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
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode 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
}'