Organización de práctica

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.

Alcance

developer_platform:read

Permiso

Ver el módulo · Solo owner, admin

Tool del MCP

platform_sandbox_getEn la superficie completa; en la compacta, mb_execute_operation con id: "platform.sandbox.get".

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

Parámetros

Sin parámetros.

Respuesta

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/sandbox" \
  -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/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.

Pide confirmación: primero dry_run: true (vista previa y confirm_token, que vale 10 minutos y una sola vez), después el mismo cuerpo con confirm_token. En unas pocas, solo con ciertos datos: la descripción dice cuándo. Por qué y cómo: Vista previa y confirmación.

Alcance

developer_platform:write y «Permitir eliminar» (developer_platform:delete en OAuth)

Permiso

Editar en el módulo · Solo owner, admin

Tool del MCP

platform_sandbox_resetEn la superficie completa; en la compacta, mb_execute_operation con id: "platform.sandbox.reset".

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

Parámetros

Sin parámetros.

Respuesta

Errores

Ejemplo

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
}'

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 -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
}'