Configurações

Get the seller scope setting

crm.settings.seller_scope.get

Returns whether the organization enforces the seller scope (enforced: sellers with the sales_rep role only see and work their own records, the unassigned ones and the pipelines they have access to), who changed it last and when, and whether the one-time normalization of records without owner finished (backfilled_at; 0 means pending).

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_settings_seller_scope_getNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.seller_scope.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/crm/settings/seller-scope" \
  -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/crm/settings/seller-scope" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Turn the seller scope on or off

crm.settings.seller_scope.update

Turns the seller scope on (enforced: true) or off for the whole organization. It first recomputes the scope stored on every seller (what the security rules read) and only then saves the switch, so a failure leaves the organization as it was. Turning it on also schedules, after responding, the one-time normalization of records without owner if it never finished (deals, persons and companies without the field become unassigned; a prospect goes to the owner of its person when they are a member of the organization, or becomes unassigned). It changes at once what every sales_rep sees; returns how many sellers changed. Only owners, admins and CRM admins.

Escopo

crm:write

Permissão

Editar no módulo

Tool do MCP

crm_settings_seller_scope_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.seller_scope.update".

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

Parâmetros

Resposta

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/crm/settings/seller-scope" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enforced": 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.

curl -X PATCH "https://api.mb-suite.com/v1/crm/settings/seller-scope" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enforced": true
}'

Get the AI scoring configuration

crm.settings.scoring.get

Returns the AI scoring setup of the CRM: one block for prospects and one for deals (enabled, the AI agent that scores, extra qualified / not-qualified criteria) plus the deal coach block (enabled, agent, coaching focus, offer context, what to avoid), each with its knowledge files (name, type, size, embedding status). Blocks never configured come back with their defaults (disabled).

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_settings_scoring_getNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.scoring.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/crm/settings/scoring" \
  -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/crm/settings/scoring" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Remove a knowledge file from an AI scoring block

crm.settings.scoring.knowledge.delete

Removes one knowledge file (entry_id, from crm.settings.scoring.get) from a block (prospects, deals or coach): its indexed text stops feeding the AI agent at once. Cannot be undone; the file would have to be uploaded again from the screen. The dry run names the file and answers knowledge_entry_not_found when it is not in that block; running it again after it is gone does nothing. Requires manage_ai_config.

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

crm:write e «Permitir exclusões» (crm:delete no OAuth)

Permissão

Editar no módulo · Ação do CRM: manage_ai_config

Tool do MCP

crm_settings_scoring_knowledge_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.scoring.knowledge.delete".

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

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/settings/scoring/{block}/knowledge/{entry_id}/delete" \
  -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.

curl -X POST "https://api.mb-suite.com/v1/crm/settings/scoring/{block}/knowledge/{entry_id}/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Score a sample lead with the current configuration

crm.settings.scoring.test

Scores a sample prospect or deal (block: prospects or deals; sample: name, email, phone, company, job title, title, source channel, value, custom fields) with that block's AI agent and criteria, exactly as real leads are scored, and returns the score, its rules and AI parts, the recommendation, the reasoning and the rule signals. Use it to check a scoring configuration before turning it on. Nothing is stored in the CRM. Spends the organization's AI credits (charged by the tokens the model actually used, its thinking included): before calling the AI it checks that the caller's credit pool covers the call with the block's model, and if it does not it fails with 402 ai_credits_exhausted (details.reason: insufficient_credits, category_budget or personal_limit) without calling the AI. If the AI fails, the score is rules only (it says so in the reasoning) and nothing is charged; if the AI answers with something that cannot be used, the score is rules only too and that answer is charged. Not available in the practice organization (test keys): 409 sandbox_external_unavailable. Not idempotent. Requires manage_ai_config.

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

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_ai_config

Tool do MCP

crm_settings_scoring_testNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.scoring.test".

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

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/settings/scoring/test" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "block": "prospects",
  "sample": {},
  "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.

Get the visible attribution model

crm.settings.attribution.get

Returns which touch of a lead's attribution history the CRM shows as its current source: first (default, the acquisition channel never changes when the lead comes back) or last (the most recent touch with evidence). It is a display preference; the stored attribution of each record is always the first touch.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_settings_attribution_getNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.attribution.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/crm/settings/attribution" \
  -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/crm/settings/attribution" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Set the visible attribution model

crm.settings.attribution.update

Sets the attribution model shown across the CRM (source card, record header, tables): first or last touch. Only changes what is displayed from now on; no record is rewritten. Requires full access to the CRM.

Escopo

crm:write

Permissão

Editar no módulo

Tool do MCP

crm_settings_attribution_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.attribution.update".

Custo declarado: até 0 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/crm/settings/attribution" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "first"
}'

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

Get the CRM's organization settings (own domains, prospect currency)

crm.settings.own_domains.get

Returns the organization's own email domains (lowercase, sorted): the CRM treats mail from or to them as internal traffic, so it never creates a company by those domains nor matches records by them. It also returns prospect_currency, the default currency shown for prospects without one (set with crm.settings.prospects.update; null = the workspace's main currency). Other CRM settings have their own operations (crm.settings.scoring.get, crm.settings.attribution.get, crm.settings.seller_scope.get).

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_settings_own_domains_getNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.own_domains.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/crm/settings/own-domains" \
  -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/crm/settings/own-domains" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Replace the organization's own email domains

crm.settings.own_domains.update

Replaces the whole list of own email domains (up to 50). Entries are normalized (lowercase, no scheme, no leading www., nothing after a slash) and deduplicated; an invalid domain or a public mailbox provider (gmail.com, outlook.com, yahoo.com…) rejects the call. Sending the same list changes nothing. Requires an owner, an admin or a CRM admin.

Escopo

crm:write

Permissão

Editar no módulo

Tool do MCP

crm_settings_own_domains_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.own_domains.update".

Custo declarado: até 0 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/crm/settings/own-domains" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domains": [
    "DOMAIN"
  ]
}'

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/crm/settings/own-domains" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domains": [
    "DOMAIN"
  ]
}'

Set the default currency shown for prospects

crm.settings.prospects.update

Saves the org-level prospect settings: prospect_currency, the ISO code (3 letters) used to display prospect values that have no currency. It is a display preference: no prospect is rewritten. Requires full access to the CRM.

Escopo

crm:write

Permissão

Editar no módulo

Tool do MCP

crm_settings_prospects_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.settings.prospects.update".

Custo declarado: até 0 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/crm/settings/prospects" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prospect_currency": "PROSPECT_CURRENCY"
}'

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