Configurações

Get the client portal settings

client_portal.settings.get

Returns this workspace's client portal setup: name (the portal's own or the organization's), logo, logo_dark and favicon (absolute URLs), slug (the <slug>.mb-suite.com subdomain) and subdomain_enabled, the custom domain with domain_verified and domain_enabled, configured (false while there is no subdomain: clients cannot be invited until there is one) and urls (the addresses clients use today, custom domain first). Only owners and admins.

Escopo

client_portal:read

Permissão

Ver o módulo · Só owner, admin

Tool do MCP

client_portal_settings_getNa superfície completa; na compacta, mb_execute_operation com id: "client_portal.settings.get".

Custo declarado: até 1 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/client-portal/settings" \
  -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/client-portal/settings" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Rename the portal or turn its addresses on or off

client_portal.settings.update

Edits the client portal settings that do not touch another platform: updates.name (portal name in the browser tab, the login page and invitation emails), updates.subdomain_enabled and updates.domain_enabled (turn the <slug>.mb-suite.com address or the custom domain on or off; turning one on requires it to exist: portal_subdomain_not_set / portal_domain_not_set, 409). With an address off, clients see an «unavailable» page there; the change can take up to 5 minutes to show. Adding, changing or removing the subdomain or the custom domain is branding.portal_domains.add / branding.portal_domains.remove (and verifying the domain, branding.portal_domains.verify); the logos and the favicon are uploaded in the app. Returns the settings and changed_fields (empty when nothing changed). Only owners and admins.

Escopo

client_portal:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

client_portal_settings_updateNa superfície completa; na compacta, mb_execute_operation com id: "client_portal.settings.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/client-portal/settings" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

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/client-portal/settings" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'