Territórios

List sales territories

crm.territories.list

Lists the organization's sales territories by name (up to 500), each with the countries (ISO codes), regions and industries it covers and the sellers assigned to it (assigned_user_ids). An assignment rule with method territory routes a lead to the first of its territories that covers the lead's country or region and rotates among that territory's sellers.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_territories_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.territories.list".

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

Create a sales territory

crm.territories.create

Creates a sales territory with a name, optional description, the countries (ISO 3166-1 alpha-2 codes such as ar or mx, or global: country_invalid otherwise), regions and industries it covers, and the sellers assigned to it (assigned_user_ids: people with access to the organization, from crm.team.list; may be empty; recipient_without_access otherwise). Use its id in an assignment rule's territory_ids (method territory). Requires manage_assignment (owners, admins and CRM admins).

Escopo

crm:write

Permissão

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

Tool do MCP

crm_territories_createNa superfície completa; na compacta, mb_execute_operation com id: "crm.territories.create".

Custo declarado: até 0 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/crm/territories" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "assigned_user_ids": [
    "ASSIGNED_USER_ID"
  ]
}'

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/territories" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "assigned_user_ids": [
    "ASSIGNED_USER_ID"
  ]
}'

Update a sales territory

crm.territories.update

Updates a territory: only the fields sent change (description null clears it; each list sent replaces the current one), validated like at creation; with nothing to change, no_changes. Requires manage_assignment.

Escopo

crm:write

Permissão

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

Tool do MCP

crm_territories_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.territories.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/crm/territories/{territory_id}" \
  -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 PATCH "https://api.mb-suite.com/v1/crm/territories/{territory_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Delete a sales territory

crm.territories.delete

Deletes a territory for good: territories do not go to the trash. Assignment rules that list it simply skip it from then on (remove it from their territory_ids with crm.assignment_rules.update to keep them tidy); the dry run names the territory and those rules. territory_not_found when the id does not exist (also in the dry run). Requires manage_assignment.

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_assignment

Tool do MCP

crm_territories_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.territories.delete".

Custo declarado: até 51 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/crm/territories/{territory_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/territories/{territory_id}/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'