Remetentes

Add a sender

branding.email_senders.add

Adds a sender address on the verified sending domain: email (the full address, hello@youragency.com: it must be on that domain, 400 sender_email_domain_mismatch otherwise) and name (what recipients see, up to 100 characters). Requires the domain to be verified (409 email_domain_not_verified); an address already in the list is 409 sender_exists; up to 50 senders (409 limit_reached, details.resource email_senders). The first sender in the list is the default From; a new one goes last (reorder with branding.email_senders.reorder). Returns the new sender and the whole list. 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_senders_addNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_senders.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/branding/email-senders" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "email": "ana@example.com",
  "name": "NAME"
}'

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/branding/email-senders" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "email": "ana@example.com",
  "name": "NAME"
}'

Rename a sender

branding.email_senders.update

Changes the display name of a sender (name, up to 100 characters); the address itself does not change (remove the sender and add another). The same name changes nothing (changed false). Not found if the sender id is not in the list. Returns the sender and the whole list. 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_senders_updateNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_senders.update".

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

Parâmetros

Resposta

Erros

Exemplo

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

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-senders/{sender_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "NAME"
}'

Reorder the senders

branding.email_senders.reorder

Sets the order of the senders: sender_ids lists every sender id exactly once, in the new order (400 sender_ids_mismatch otherwise). The first one becomes the default From for the emails that do not pick a sender (flows, reports, shared emails), so this is a real change, not a display preference. The same order changes nothing (changed false). Returns the list. 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_senders_reorderNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_senders.reorder".

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/branding/email-senders/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "sender_ids": [
    "SENDER_ID"
  ]
}'

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/branding/email-senders/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "sender_ids": [
    "SENDER_ID"
  ]
}'

Remove a sender

branding.email_senders.remove

Removes a sender from the sending domain. At least one sender always stays (409 last_sender); removing the default one makes the next in the list the default. Emails and drafts that picked this sender fall back to the default. There is no trash: to undo, add it again with the same address and name. Not found if the sender id is not in the list. Outside the app it needs a dry run and its confirm_token. Owners and admins with edit access to Branding.

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

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

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

branding_email_senders_removeNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_senders.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/branding/email-senders/{sender_id}" \
  -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/branding/email-senders/{sender_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'