Domínio de e-mail

Get the sending domain

branding.email_domain.get

Returns the organization's email sending domain as saved: domain, status (pending until the DNS records are confirmed, then verified), added_at, verified_at, dns_records (the TXT for DKIM, the MX and the SPF TXT of the MAIL FROM subdomain, each with verified) and senders (the addresses on that domain, in order; the first is the default From), plus footer_address (the postal address printed in commercial emails). configured false when there is none. effective_domain is the domain branded emails actually go out from: the organization's own if verified, else its workspace's verified one (inherited_from_parent true), else null (MB Suite's address). It calls no external provider: branding.email_domain.verify refreshes the status. Requires view access to Branding.

Escopo

branding:read

Permissão

Ver o módulo

Tool do MCP

branding_email_domain_getNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_domain.get".

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

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

curl "https://api.mb-suite.com/v1/branding/email-domain" \
  -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/branding/email-domain" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Add the sending domain

branding.email_domain.add

Registers the domain the organization will send emails from (campaigns, flows, reports and shared emails with its brand): the root domain it owns (youragency.com; a leading send., mail., email., bounce. or reply. is dropped; never mb-suite.com). Creates the identity in the email provider and returns dns_records: a TXT record for DKIM and the MX and SPF TXT of the send. subdomain, to publish at the registrar; then branding.email_domain.verify. One sending domain per organization: with one already set, 409 email_domain_already_set (remove it first); a domain another organization already uses, 409 email_domain_in_use. 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

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

branding_email_domain_addNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_domain.add".

Custo declarado: até 6 leituras e 1 escritas por chamada (contam na cota diária). Usa uma plataforma externa (ses): conta na cota de operações externas.

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/branding/email-domain" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "DOMAIN",
  "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. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

Verify the sending domain's DNS

branding.email_domain.verify

Checks the sending domain with the email provider and, on its own, against the domain's authoritative DNS; saves the status and the dns_records with their verified flags. Returns verified and, while pending, reason_code: dns_not_found (the records are not published), dns_invalid (published with another value), dns_found_confirming (we see them, the provider is confirming: minutes) or dns_pending. If the provider had given up looking (it stops after 72 hours), the search is restarted automatically (restarted). When the domain becomes verified it fires branding.email_domain.verified once and its senders can be used. Not found without a 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_domain_verifyNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_domain.verify".

Eventos que pode emitir

branding.email_domain.verified

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária). Usa uma plataforma externa (ses): conta na cota de operações externas.

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/branding/email-domain/verify" \
  -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. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

Remove the sending domain

branding.email_domain.remove

Removes the organization's sending domain and all its senders: the identity is deleted from the email provider and branded emails go back to MB Suite's address (or to the workspace's domain, for an Account); Email Marketing campaigns and flows need a verified domain again. The DNS records at the registrar are not touched. There is no trash: to undo, add the domain again (the same records apply) and re-create the senders. Not found without a sending domain. 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_domain_removeNa superfície completa; na compacta, mb_execute_operation com id: "branding.email_domain.remove".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária). Usa uma plataforma externa (ses): conta na cota de operações externas.

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/branding/email-domain" \
  -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. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.