Rodapé dos e-mails · Branding · Referência da API

PATCH/v1/branding/email-footer

Set the postal address of the email footer

branding.email_footer.update

EscritaIdempotenteDesde 2026-11-01

Sets the postal address printed in the footer of the organization's commercial emails (CAN-SPAM requires one): address up to 200 characters; null or an empty string removes it. The same address changes nothing (changed false). It is independent of the sending domain. Owners and admins with edit access to Branding.

Escopo: branding:write
Permissão: Editar no módulo · Só owner, admin
Tool do MCP: branding_email_footer_updateNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_footer.update".

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

Parâmetros

addressstring | nullcorpoobrigatório

The postal address printed in the footer of commercial emails (CAN-SPAM), up to 200 characters. null or an empty string removes it.

Resposta

footer_addressstring | null

changedboolean

Erros

role_required invalid_input unknown_field authentication_required scope_insufficient crm_action_denied idempotency_key_reused rate_limited quota_exceeded

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/branding/email-footer" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "ADDRESS"
}'

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 PATCH "https://api.mb-suite.com/v1/branding/email-footer" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "ADDRESS"
}'