Configurações

Get the brand kit

branding.settings.get

Returns the organization's brand kit, what the white-label app, the login, the emails and the PDF reports show: app_name, logo, logo_dark, logo_icon, favicon, report_logo (images), primary_color, accent_color, brand_colors (hex colors), heading_font and body_font (email-safe fonts), button_shape (square, rounded, pill), button_style (filled, outlined), button_color and button_text_color, plus heading_font_name and body_font_name (the short names of the font stacks), configured_at, configured_by and configured_by_name (who saved it last). Image fields are absolute URLs. It reads the organization as it is now (not a copy kept for a few seconds), so a write is visible right away. settings is the organization's own kit (null when it never set one; configured says whether it has anything), and effective_settings what is actually shown: an Account without a kit of its own shows its workspace's (inherited_from_parent true). Addresses (domains, subdomains) are in branding.domains.get; the sending domain in branding.email_domain.get. Requires view access to Branding.

Escopo

branding:read

Permissão

Ver o módulo

Tool do MCP

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

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

Update the brand kit

branding.settings.update

Changes one or more fields of the brand kit, sent inside updates: app_name, logo, logo_dark, logo_icon, favicon, report_logo (images), primary_color, accent_color, brand_colors (hex colors), heading_font and body_font (email-safe fonts), button_shape (square, rounded, pill), button_style (filled, outlined), button_color and button_text_color. Only what is sent changes; null (or an empty string) clears a field; brand_colors replaces the whole list ([] empties it, up to 50 colors); app_name up to 100 characters; colors must be CSS hex (#RGB, #RRGGBB, #RRGGBBAA); fonts by name (Helvetica, Arial, Georgia, Times New Roman, Courier New, Verdana, Tahoma, Trebuchet MS, Lucida Sans, Impact) or by the exact stack branding.settings.get returns (anything else: 400 branding_font_invalid). An image is the https URL of a PNG, JPG, WebP, GIF or SVG: MB Suite downloads it, normalizes it and keeps its own copy (the external link is never stored); a URL that could not be downloaded leaves that field as it was and comes back in skipped_images. A URL that branding.settings.get returned for this organization is accepted as is; one from another organization's storage is rejected (400 branding_image_invalid). Unknown fields are rejected. Sending the same values changes nothing (changed_fields empty). Each change fires branding.settings.updated. Returns the kit as saved. Owners and admins with edit access to Branding.

Escopo

branding:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

branding_settings_updateNa superfície completa; na compacta, mb_execute_operation com id: "branding.settings.update".

Eventos que pode emitir

branding.settings.updated

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

Reset a section of the brand kit

branding.settings.reset_section

Puts one section of the brand kit back to MB Suite's defaults by clearing its fields: colors (primary_color, accent_color, brand_colors), fonts (heading_font, body_font) or buttons (button_shape, button_style, button_color, button_text_color). Logos, favicon and app name are not touched (clear them with branding.settings.update). Returns cleared_fields and previous (the values that were cleared, by public name: send them back to branding.settings.update to undo). A section already at the defaults changes nothing (cleared_fields empty). Fires branding.settings.updated with reset_section. Owners and admins with edit access to Branding.

Escopo

branding:write

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

branding_settings_reset_sectionNa superfície completa; na compacta, mb_execute_operation com id: "branding.settings.reset_section".

Eventos que pode emitir

branding.settings.updated

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/settings/reset" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "section": "colors"
}'

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/settings/reset" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "section": "colors"
}'