Update user

PUT

/v2/user

Update user information. To enable automatic withdrawals, both auto_withdraw_enabled and auto_withdraw_lightning_address must be provided.

Request Body

Body

object

auto_withdraw_enabled

boolean

auto_withdraw_lightning_address

string

username

string

use_taproot_addresses

boolean

show_leaderboard

boolean

Example

{
  "show_leaderboard": false
}

Responses

200

200

object

uid

required

string format: uuid

role

required

string

Allowed values: user moderator operator admin

balance

required

number

>= -9007199254740991 <= 9007199254740991

username

required

string

<= 64 characters

synthetic_usd_balance

required

number

>= -9007199254740991 <= 9007199254740991

linkingpublickey

required

string

nullable

show_leaderboard

required

boolean

email

required

string

nullable <= 318 characters

email_confirmed

required

boolean

use_taproot_addresses

required

boolean

account_type

required

string

<= 64 characters

auto_withdraw_enabled

required

boolean

auto_withdraw_lightning_address

required

string

nullable <= 100 characters

totp_enabled

required

boolean

webauthn_enabled

required

boolean

fee_tier

required

integer

>= -2147483648 <= 2147483647

metrics

nullable

Example

{
  "uid": "1602a190-9dc0-48ff-9fb9-4b62f7270007",
  "role": "user",
  "balance": 69420,
  "username": "alice",
  "synthetic_usd_balance": 0,
  "linkingpublickey": "037b7c2587f823de3c62a639369b8c939bfb8f0bd40df58e9c1b6df63bcc88df4f",
  "show_leaderboard": false,
  "email_confirmed": false,
  "use_taproot_addresses": false,
  "account_type": "lnurl",
  "auto_withdraw_enabled": false,
  "fee_tier": 0,
  "totp_enabled": false,
  "webauthn_enabled": false
}

400

400