delete_shared_account

Deletes a shared account (family HOUSEHOLD or enterprise GROUP) by organizationId.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Deletes data
  • Required scope: write (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_shared_account",
    "arguments": {
      "organizationId": "demo_organization_01"
    }
  }
}

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Deletes a shared account (family HOUSEHOLD or enterprise GROUP) by organizationId.

Get organizationId from list_shared_accounts or read_shared_account.

Input parameters

NameTypeRequiredDescription
organizationIdstringYes
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "organizationId": {
      "type": "string"
    }
  },
  "required": [
    "organizationId"
  ],
  "type": "object"
}