Organização de prática

The practice organization of the workspace

platform.sandbox.get

Returns the state of the practice organization that test keys (mbs_test_…) work on: whether it exists (it is created with the first test key), its id, when it was created, seeded and last reset, how many test keys of the workspace are active, and which operations that reach an external platform it simulates (the rest of those answer 409 sandbox_external_unavailable there). Called on the workspace or, with a test key, on the practice organization itself; on an Account it answers available: false with reason account_has_no_practice and its workspace in workspace_id. Owners and admins. Module: API & MCP (developer_platform), even though the id starts with platform.; the credential needs the developer_platform:read scope.

Escopo

developer_platform:read

Permissão

Ver o módulo · Só owner, admin

Tool do MCP

platform_sandbox_getNa superfície completa; na compacta, mb_execute_operation com id: "platform.sandbox.get".

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

Reset the practice organization's data

platform.sandbox.reset

Deletes everything the practice organization (the one test keys work on) has accumulated —CRM records, trash, webhook events and deliveries, jobs and any other module data— and seeds the example data again: a CRM (a pipeline with its stages, companies, persons, deals in different stages and activities) and a few activity labels to try labeling entries. Test keys and the practice webhook subscriptions are kept, and so is the day's usage of the practice organization. It cannot be undone and nothing goes to the trash. Run it with dry_run first to see what will be deleted; when complete is false the call ran out of time, so run the dry run again and call it with the new confirm_token to finish (a confirm_token works once). Called on the workspace or, with a test key, on the practice organization itself. Owners and admins. Module: API & MCP (developer_platform), even though the id starts with platform.; the credential needs the developer_platform:write scope and permission to delete.

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

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

Permissão

Editar no módulo · Só owner, admin

Tool do MCP

platform_sandbox_resetNa superfície completa; na compacta, mb_execute_operation com id: "platform.sandbox.reset".

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

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/sandbox/reset" \
  -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/sandbox/reset" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'