Menú

Referencia de la API · Branding

Dominios

branding · domains · 2 operaciones

GET/v1/branding/domains

Get the organization's addresses

branding.domains.get

LecturaIdempotenteDesde 2026-11-01

Returns the addresses the organization has registered, on two surfaces: team_access (the white-label app the agency's team uses) and client_portal (what its clients open), each with custom_domain (its own hostname, with verified: the hosting provider confirmed the DNS) and subdomain (<label>.mb-suite.com), or null where there is none. Each address has host, kind, enabled (an address can be kept but turned off) and added_at. cname_target is where a custom domain's CNAME must point (cname.vercel-dns.com). It calls no external provider. Requires view access to Branding.

Alcance
branding:read
Permiso
Ver el módulo
Tool del MCP
branding_domains_getEn la superficie completa; en la compacta, mb_execute_operation con id: "branding.domains.get".

Costo declarado: hasta 1 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

Sin parámetros.

Respuesta

team_accessobject
client_portalobject
cname_targetstring

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/branding/domains" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/branding/domains" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/branding/domains/availability

Check whether an address is available

branding.domains.check_availability

LecturaIdempotenteDesde 2026-11-01

Says whether this organization could register an address on a surface (team_access by default, or client_portal) without changing anything or calling the hosting provider. host is a full hostname (app.youragency.com, or youragency.mb-suite.com for an MB Suite subdomain) or just a subdomain label (youragency). Returns host (always the full hostname: youragency.mb-suite.com for a subdomain), label (the subdomain label; null for a custom domain), kind (custom_domain or subdomain), available, current (the organization already has it on that surface) and, when not available, reason and message (in the language of the messages): format, length (a label is 3 to 63 letters, digits or hyphens), reserved (labels MB Suite keeps: api, mcp, app, www…), platform (mb-suite.com itself or a hosting provider's domain cannot be a custom domain), taken_other_organization or taken_other_surface (this organization already uses it on the other surface). Requires view access to Branding.

Alcance
branding:read
Permiso
Ver el módulo
Tool del MCP
branding_domains_check_availabilityEn la superficie completa; en la compacta, mb_execute_operation con id: "branding.domains.check_availability".

Costo declarado: hasta 15 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

hoststringqueryrequerido

What to check: a full hostname (app.youragency.com, or youragency.mb-suite.com for an MB Suite subdomain) or just a subdomain label (youragency).

surfaceenumqueryopcional

Where it would be used: team_access (the white-label app, default) or client_portal.

Valores: team_access, client_portal · Por defecto: "team_access"

Respuesta

hoststring

The full hostname checked (an MB Suite subdomain always with its domain: youragency.mb-suite.com).

kindenum | null

custom_domain or subdomain (an MB Suite subdomain).

Valores: custom_domain, subdomain

surfaceenum

Where it was checked: team_access or client_portal.

Valores: team_access, client_portal

availableboolean

True when this organization can take it there.

currentboolean

True when the organization already has it on that surface.

reasonenum | null

Why it is not available (null when it is).

Valores: format, length, reserved, platform, taken_other_organization, taken_other_surface

messagestring | null

What to tell the person (in the language of the messages: English through the API and MCP); null when it is available.

labelstring | null

For an MB Suite subdomain, its label (youragency); null for a custom domain.

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/branding/domains/availability?host=HOST" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/branding/domains/availability?host=HOST" \
  -H "Authorization: Bearer $MB_TEST_KEY"