Menu

Referência da API · Brand Voice

Perfil

social_brand_voice · profile · 3 operações

GET/v1/social-brand-voice/profile

Get the brand voice profile

social_brand_voice.profile.get

LeituraIdempotenteDesde 2026-11-01

Returns the organization's Brand Voice, the guide MB Suite's AI follows when it writes captions, video scripts, post ideas and inbox replies: personality (tones, custom_tone_note, communication_style), vocabulary (preferred_words, avoided_words, jargon_level), format (emoji_usage, hashtag_usage, post_structure), audience (audience_persona, tone_adaptation_note), per-network adjustments (platform_adjustments for instagram, facebook, linkedin and tiktok: tone_note, max_caption_length, include_hashtags) and ai_summary, the short description shown on the Brand Voice screen. configured=false and profile=null when it was never set or was reset. Values: tones formal, casual, friendly, authoritative, inspirational, humorous or educational; communication_style descriptive, narrative, direct or conversational; jargon_level avoid, moderate or technical; emoji_usage none, minimal, moderate or free; hashtag_usage none, moderate or per_platform. Requires view access to Brand Voice.

Escopo
social_brand_voice:read
Permissão
Ver o módulo
Tool do MCP
social_brand_voice_profile_getNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.profile.get".

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

Parâmetros

Sem parâmetros.

Resposta

configuredboolean
profileobject | null

Erros

Exemplo

curl "https://api.mb-suite.com/v1/social-brand-voice/profile" \
  -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/social-brand-voice/profile" \
  -H "Authorization: Bearer $MB_TEST_KEY"
PATCH/v1/social-brand-voice/profile

Update the brand voice profile

social_brand_voice.profile.update

EscritaIdempotenteDesde 2026-11-01

Changes one or more fields of the Brand Voice (updates object) and creates the profile if there was none. Only what is sent changes: tones, preferred_words and avoided_words replace the whole list ([] empties it); null clears a text or option field; platform_adjustments replaces all the per-network adjustments (keys instagram, facebook, linkedin, tiktok; null removes them). Values: tones formal, casual, friendly, authoritative, inspirational, humorous or educational; communication_style descriptive, narrative, direct or conversational; jargon_level avoid, moderate or technical; emoji_usage none, minimal, moderate or free; hashtag_usage none, moderate or per_platform. Through the API and the MCP it never spends AI: when a field that ai_summary describes changes (tones, communication style, tone note, emojis, hashtags, preferred or avoided words, audience) the summary is cleared, and the screen writes it again the next time someone saves there, unless updates.ai_summary brings one written by hand (up to 1,000 characters): then it is saved as sent even if those fields change in the same request (null clears it), and it stays until someone changes a field it describes without sending a new one, or saves on the screen after changing one. On the screen the summary is rewritten with AI and uses the AI credits of the person who saves; with no credits left the profile is still saved, without a new summary. ai_summary_status says what happened (provided, regenerated, kept, cleared, failed, or no_credits when the screen could not rewrite it for lack of AI credits); a hand-written summary that changed also comes in changed_fields as ai_summary. Sending the same values changes nothing (changed_fields comes back empty). Every change fires social_brand_voice.profile.updated. If someone else saved at the same instant it fails with brand_voice_profile_changed (409): read the profile again and retry. Returns the profile as it was saved. Requires edit access to Brand Voice.

Instruções para agentes

If ai_summary_status is cleared, tell the person that the summary on the Brand Voice screen is rewritten the next time someone saves there (or offer to write it with updates.ai_summary); the AI already uses the new values.

Escopo
social_brand_voice:write
Permissão
Editar no módulo
Tool do MCP
social_brand_voice_profile_updateNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.profile.update".
Eventos que pode emitir
social_brand_voice.profile.updated

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

Parâmetros

updatesobjectcorpoobrigatório

What changes (only what comes is touched; lists replace the whole list, null clears a text or an option). Creates the profile if there is none.

Resposta

profileobject
changed_fieldsarray<string>
ai_summary_statusenum

Valores: regenerated, kept, cleared, failed, provided, no_credits

ai_summary_credits_codeenum

Only with ai_summary_status no_credits (a save from the app): why the summary was not rewritten.

Valores: ai_credits_exhausted, ai_personal_limit, payment_required

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/social-brand-voice/profile" \
  -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/social-brand-voice/profile" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'
DELETE/v1/social-brand-voice/profile

Reset the brand voice profile

social_brand_voice.profile.reset

IrreversívelIdempotenteDesde 2026-11-01

Resets the Brand Voice: deletes the whole profile (tones, vocabulary, format, audience and per-network adjustments) and MB Suite's AI stops applying it. The documents uploaded to Brand Voice stay (delete them with social_brand_voice.documents.delete). The profile goes to the 30-day trash and owners and admins can restore it; if a new profile was saved in between, reset that one first and then restore the old one. With no profile configured it does nothing (reset=false). Fires social_brand_voice.profile.updated with profile=null. Outside the screen it needs confirmation: a dry run and its confirm_token, or the simple DELETE of the REST API. Requires edit access to Brand Voice.

Com uma API key, este DELETE roda direto: o registro fica 30 dias na lixeira e a resposta traz o seu trash_item_id. Com um token OAuth, e pelo MCP, pede dry_run → confirm_token.

Escopo
social_brand_voice:write e «Permitir exclusões» (social_brand_voice:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
social_brand_voice_profile_resetNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.profile.reset".
Eventos que pode emitir
social_brand_voice.profile.updated

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

Parâmetros

Sem parâmetros.

Resposta

resetboolean
trash_item_idstring

The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.

trash_item_idsarray<string>

Only when the deletion left more than one copy: all of them, the first being trash_item_id.

trash_expires_atnumber

When the copy leaves the trash for good (epoch ms): 30 days after the deletion.

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/social-brand-voice/profile" \
  -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 -X DELETE "https://api.mb-suite.com/v1/social-brand-voice/profile" \
  -H "Authorization: Bearer $MB_TEST_KEY"