Menu

API reference · Integrations

Connection mode

integrations · platform_mode · 1 operation

POST/v1/integrations/platforms/{platform}/mode

Choose own or inherited connection for a platform

integrations.platform_mode.change

WriteIdempotentSince 2026-11-01

In an Account, chooses whether a platform uses the Account's own connection (mode own) or its workspace's (mode inherited). In an Account managed or paid by the workspace, the workspace's owners and admins decide (403 role_required, details.scope workspace); in an Account that pays for itself, its own owners and admins (403 role_required, details.scope direct), and inherited only makes the platform available: the workspace then connects it (integrations.inheritance.activate). Switching from inherited to own unlinks the platform's inherited accounts (cleaned_platforms). Choosing the current mode changes nothing (changed: false). Errors: 400 not_an_account in a workspace, 409 billing_mode_not_supported in an independent Account.

Scope
integrations:write
Permission
Edit in the module
MCP tool
integrations_platform_mode_changeOn the full surface; on the compact one, mb_execute_operation with id: "integrations.platform_mode.change".

Declared cost: up to 2 reads and 1 writes per call (they count against the daily quota).

Parameters

platformenumpathrequired

The platform whose mode changes in this Account.

modeenumbodyrequired

own: the Account connects its own; inherited: it uses the workspace's connection.

Values: own, inherited

Response

changedboolean
cleaned_platformsarray<string>

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/integrations/platforms/{platform}/mode" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "mode": "own"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/integrations/platforms/{platform}/mode" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "mode": "own"
}'