Hanzo
OpenapiLeaderboard

Sets the ORG's listing on the cross-org global board.

Sets the ORG's listing on the cross-org global board.

PUT /v1/leaderboard/optin/org

Addresshttps://api.hanzo.ai/v1/leaderboard/optin/org
MethodPUT
Operationput_leaderboard_optin_org
AuthAuthorization: Bearer $HANZO_API_KEY

Sets the ORG's listing on the cross-org global board. Only an admin of the caller's own org — an org admin or a platform SuperAdmin — may change it, and the org written is the caller's validated tenant, never a value from the request. Listing consents to publishing the org's usage VOLUME; cross-org spend stays restricted to platform admins regardless.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
displaybodystringDisplay is the name shown for the org on that board: 1-40 characters of letters, digits, space, dot, underscore, apostrophe or hyphen.
listedbodybooleanListed publishes the org on the cross-org global board when true, and withdraws it when false.

Response

StatusBodyMeaning
200orgOptinViewok

200 body — 3 fields.

FieldInTypeAlwaysDescription
canManagebodybooleanCanManage is true only for an admin of this org (or a platform SuperAdmin) — the callers whose write of the org preference will be accepted.
displaybodystringDisplay is the name shown for the org on that board.
listedbodybooleanListed is true when the org has opted onto the cross-org global board.

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