Delete a user

{
  "success": true,
  "data": { "external_id": "user_8412", "deleted": true, "unlinked": true },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

{
  "success": true,
  "data": { "external_id": "user_8412", "deleted": true, "unlinked": true },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Removes one of your platform users.

Managed user: the account and its data are deleted. Tracking of its wallets stops at the next sync.
Claimed user: the person owns the account now, so only the link to your platform is removed. They keep their CabalSpy ID.

Afterwards the external_id is free again and can be created anew.

Body

string

required

Your id of the user. Alternatively pass csid_id.

Usage Example

curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/delete" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "user_8412"}'

import requests

r = requests.post("https://api-id.cabalspy.xyz/v1/platform-users/delete",
                  json={"external_id": "user_8412"},
                  headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["data"])

const res = await fetch("https://api-id.cabalspy.xyz/v1/platform-users/delete", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ external_id: "user_8412" }),
});
const { data } = await res.json();
console.log(data.deleted, data.unlinked);

Response

object

Show data

string

Your id of the user.

boolean

True when the managed account and its data were deleted. False for a claimed user.

boolean

Always true: the user is no longer one of your platform users.

{
  "success": true,
  "data": { "external_id": "user_8412", "deleted": true, "unlinked": true },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Errors

Status	Code	Meaning
400	missing_parameter	external_id missing.
400	invalid_parameter	external_id or csid_id invalid.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
404	platform_user_not_found	No user with this id in your instance.
429	rate_limit_exceeded	Rate limit exceeded.

See Errors for the full list.

Introduction

Login

Data API

Users

Trading

Theses

Streams

White-Label

Competitions

Reference

Body

Usage Example

Response

Errors

​Body

​Usage Example

​Response

​Errors

Body

Usage Example

Response

Errors