Hanzo
OpenapiLeaderboard

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

Addresshttps://api.hanzo.ai/v1/leaderboard/optin
MethodPUT
Operationput_leaderboard_optin
AuthAuthorization: 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).

FieldInTypeRequiredDescription
handlebodystringHandle is the display name shown on a listed row: 1-40 characters of letters, digits, space, dot, underscore, apostrophe or hyphen.
listedbodybooleanListed publishes the caller's row to other viewers of the board when true, and anonymizes it when false.

Response

StatusBodyMeaning
200userOptinViewok

200 body — 3 fields.

FieldInTypeAlwaysDescription
canSetbodybooleanCanSet is false when the caller's ledger identity cannot be resolved (no user name on the principal).
handlebodystringHandle is the display name on the caller's listed row.
listedbodybooleanListed 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.


Leaderboard API · All Hanzo APIs · Interactive reference

How is this guide?

On this page