Hanzo
OpenapiAffiliate

Sets the caller's public leaderboard display name, or clears it.

Sets the caller's public leaderboard display name, or clears it. The handle IS the opt-in.

POST /v1/affiliate/me/handle

Addresshttps://api.hanzo.ai/v1/affiliate/me/handle
MethodPOST
Operationpost_affiliate_me_handle
AuthAuthorization: Bearer $HANZO_API_KEY

Sets the caller's public leaderboard display name, or clears it.

The handle IS the opt-in. An empty handle opts out: the affiliate keeps its rank and can still see its own row, it simply stops being listed to anyone else. That is the whole privacy control — there is no separate visibility flag, and no way to be listed without choosing a name.

Requires a validated principal and an existing affiliate record; apply first. The handle is bounded and restricted to letters, digits, space, hyphen, underscore and dot.

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
handlebodystringHandle is the public leaderboard display name; empty opts out.

Response

StatusBodyMeaning
200handleSetok

200 body — 1 field.

FieldInTypeAlwaysDescription
handlebodystringHandle is the display name as STORED, echoed back after trimming.

Failure carries the platform error shape — see Errors.

Examples

hanzo affiliates me handle

Affiliate API · All Hanzo APIs · Interactive reference

How is this guide?

On this page