Skip to content

Claim the network-wide username

POST
/api/protocol/v1/users/me/username

Lowercase a-z 0-9 -, 3–32 chars, unique. Mirrors into the streamer handle. Scope profile:write.

object
username
required
string
Example
lukas

Claimed

invalid_request / invalid_scope / invalid_grant

object
error
required

Stable machine-readable code (snake_case) or a short reason.

string
message
string
key
additional properties
any

unauthenticated

object
error
required

Stable machine-readable code (snake_case) or a short reason.

string
message
string
key
additional properties
any

insufficient_scope / forbidden

object
error
required

Stable machine-readable code (snake_case) or a short reason.

string
message
string
key
additional properties
any

Username_taken

object
error
required

Stable machine-readable code (snake_case) or a short reason.

string
message
string
key
additional properties
any