> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cabalspy.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Settings

> GET and POST /v1/platform-users/settings: the White-Label settings of your instance: white_label, data_scope, wallet_trust, leaderboard_trust, claim_links and telegram_alerts.

Read and change the White-Label settings of your instance. A `POST` changes only the settings you pass and returns all of them. See [Settings](https://docs.cabalspy.xyz/cabalspy-id/white-label.md#settings) in the overview for what each one does.

The same settings are on the instance's [White-label](https://docs.cabalspy.xyz/cabalspy-id/dashboard.md#white-label) tab in the dashboard. Saving them there always sends all of them, including `claim_links`.

## Read the settings

`GET /v1/platform-users/settings`

```bash theme={null}
curl "https://api-id.cabalspy.xyz/v1/platform-users/settings" \
  -H "Authorization: Bearer YOUR_KEY"
```

## Change the settings

`POST /v1/platform-users/settings`

**white\_label** `boolean`

Dashboard: **No CabalSpy ID branding**. The verify widget and the texts your users see do not mention CabalSpy ID. While claim\_links has never been set, claim links are off when this is true and on when it is false.

**data\_scope** `string`

Dashboard: **Where your users' data is visible**. `csid` (default): your users are part of the CabalSpy ID network: profiles, leaderboard, Trade Feed and theses. `platform`: only your instance sees them, nothing appears on CabalSpy ID's public pages or other platforms.

**wallet\_trust** `string`

Dashboard: **Wallets that count**. `all`: unverified wallets you send count for data, profiles and leaderboards. `verified_only`: only payment-verified wallets count; unverified ones get the status `needs_verification`.

**leaderboard\_trust** `string`

Dashboard: **Leaderboard**. `all` or `verified_only`: which wallets the [platform leaderboard](https://docs.cabalspy.xyz/cabalspy-id/platform-users-leaderboard.md) ranks. `trust=verified` on the leaderboard request can only narrow it further.

**claim\_links** `boolean`

Dashboard: **Claim links**. Whether you can create [claim links](https://docs.cabalspy.xyz/cabalspy-id/platform-users-claim.md). When off, creating one returns `claim_disabled`.

**telegram\_alerts** `boolean`

Dashboard: **Telegram alerts for your users**. Trade Feed alerts through the CabalSpy ID Telegram bot for platform users who [linked Telegram](https://docs.cabalspy.xyz/cabalspy-id/platform-users-telegram.md).

**network\_sharing** `boolean`

Older form of data\_scope: true is `csid`, false is `platform`.

Unknown settings are refused with `invalid_parameter`, which lists the allowed ones.

```bash cURL theme={null}
curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/settings" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wallet_trust": "all", "leaderboard_trust": "verified_only", "claim_links": false}'
```

```python Python theme={null}
import requests

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

```javascript JavaScript theme={null}
const res = await fetch("https://api-id.cabalspy.xyz/v1/platform-users/settings", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ white_label: true }),
});
const { data } = await res.json();
console.log(data.white_label, data.claim_links);
```

## Response

**name** `string`

The instance's name.

**white\_label** `boolean`

White-label flag.

**data\_scope** `string`

`csid` or `platform`.

**network\_sharing** `boolean`

The same as data\_scope, as a boolean.

**wallet\_trust** `string`

`all` or `verified_only`.

**leaderboard\_trust** `string`

`all` or `verified_only`.

**claim\_links** `boolean`

Whether claim links are on, including the default from white\_label.

**telegram\_alerts** `boolean`

Telegram alerts on or off.

**inbound** `object`

enabled and last\_event\_at of the [inbound URL](https://docs.cabalspy.xyz/cabalspy-id/platform-users-inbound.md).

```json Response theme={null}
{
  "success": true,
  "data": {
    "name": "Example Terminal",
    "white_label": true,
    "data_scope": "csid",
    "network_sharing": true,
    "wallet_trust": "all",
    "leaderboard_trust": "verified_only",
    "claim_links": false,
    "telegram_alerts": false,
    "inbound": { "enabled": true, "last_event_at": "2026-10-26T07:58:02Z" }
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}
```

## Errors

| Status | Code | Meaning |
| - | - | - |
| 400 | invalid\_parameter | Unknown setting, or a value that is not allowed. `allowed` lists the accepted values. |
| 401 | missing\_api\_key | API key missing. |
| 403 | invalid\_api\_key | API key invalid or not enabled for CabalSpy ID. |
| 429 | rate\_limit\_exceeded | Rate limit exceeded. |

See [Errors](https://docs.cabalspy.xyz/cabalspy-id/errors.md) for the full list.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.