Skip to main content
PATCH
Set the account name and whether the other side of a deal sees it

Authorizations

Authorization
string
header
required

An API key (hk_live_… / hk_test_…) with read/taker/maker scopes. read is read-only: every write except webhooks needs taker or maker (403 otherwise), and either of those can read too. Creating RFQs and listing tokens need taker; quoting needs maker.

Body

application/json
handle
string | null

3 to 24 characters: letters, digits and _ — stored in lowercase, unique across accounts. null clears the name, and stops showing it.

handlePublic
boolean

whether the other side of a deal sees the name and the record; true needs a name — the account's, or handle in the same request

Response

ok — the two fields as they now stand

handle
string | null
handlePublic
boolean