Sets the CALLER's own public-listing preference on the leaderboard.
Sets the CALLER's own public-listing preference on the leaderboard.
PUT /v1/leaderboard/optin
| Address | https://api.hanzo.ai/v1/leaderboard/optin |
| Method | PUT |
| Operation | put_leaderboard_optin |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sets the CALLER's own public-listing preference on the leaderboard. Self only: the row written is keyed by the caller's validated ledger identity, so this can never edit another member's visibility whatever the request says. A caller opting in with no handle is given their username, so a listed row never renders as "Anonymous" to its own owner.
Request
2 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
handle | body | string | — | Handle is the display name shown on a listed row: 1-40 characters of letters, digits, space, dot, underscore, apostrophe or hyphen. |
listed | body | boolean | — | Listed publishes the caller's row to other viewers of the board when true, and anonymizes it when false. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | userOptinView | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
canSet | body | boolean | — | CanSet is false when the caller's ledger identity cannot be resolved (no user name on the principal). |
handle | body | string | — | Handle is the display name on the caller's listed row. |
listed | body | boolean | — | Listed is true when the caller's board row is published under Handle to other viewers. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, LeaderboardApi } from 'hanzoai';
const api = new LeaderboardApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putLeaderboardOptin({ handle: "<handle>", listed: false });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LeaderboardApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LeaderboardApi(client).put_leaderboard_optin(handle="<handle>", listed=False)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.LeaderboardAPI.PutLeaderboardOptin(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, leaderboard_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = leaderboard_api::put_leaderboard_optin(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LeaderboardApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new LeaderboardApi(client).putLeaderboardOptin();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X PUT https://api.hanzo.ai/v1/leaderboard/optin \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"handle": "<handle>",
"listed": false
}'The door reaches leaderboard through the leaderboard tool, which names its 6 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_usage_activity"
}
}
}'How is this guide?