Skip to main content
PUT
Update user fields

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

User new fields data

​
email
string
Maximum string length: 255
Pattern: ^$|(^([!#-'*+\/-9=?A-Z^-~-]+(\.[!#-'*+\/-9=?A-Z^-~-]+)*|"([]!#-[^-~ \t]|([\t -~]))+")@([!#-'*+\/-9=?A-Z^-~-]+(\.[!#-'*+\/-9=?A-Z^-~-]+)*|[\t -Z^-~]*)$)
Example:

"hello-world@foobar.com"

​
alias
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
firstName
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
lastName
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
jobTitle
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
phoneNumber
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
tShirtSize
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
team
string
Maximum string length: 255
Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
policiesConsent
boolean
​
country
string | null

Standard ISO 3166-1 alpha-2 two-letter country code

Maximum string length: 255
Pattern: ^[A-Z]{2}$
Example:

"US"

​
username
string | null

Alphanumeric with slugs and underscores username

Maximum string length: 255
Pattern: ^$|^[\p{L}\p{N}_-]{3,20}$
Example:

"johndoe"

​
captchaToken
string

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

​
metadata
object
​
mfaBackupCodeAcknowledgement
enum<string> | null
Available options:
pending,
complete
​
btcWallet
string | null

BTC wallet address

Pattern: ^(bc1|[13])[a-zA-HJ-NP-Z0-9]{25,59}$
Example:

"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"

​
kdaWallet
string | null

KDA wallet address

Pattern: ^k:[0-9a-fA-F]{64}$
Example:

"k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"

​
ltcWallet
string | null

LTC wallet address

Pattern: ^[LM3][a-km-zA-HJ-NP-Z1-9]{26,53}$
Example:

"LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax"

​
ckbWallet
string | null

CKB wallet address

Pattern: ^(ckb1q|ckt1q)[0-9a-z]{25,111}$
Example:

"ckt1q9876543210abcdefghijklmnopqrstuvwxyz"

​
kasWallet
string | null

KAS wallet address

Pattern: ^kaspa:[1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz]{56,}$
Example:

"kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m"

​
dogeWallet
string | null

DOGE wallet address

Pattern: ^D[a-zA-Z0-9_.-]{33}$
Example:

"DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"

​
emailNotification
boolean
​
discordNotification
boolean
​
newsletterNotification
boolean

Response

successful operation - user fields updated

​
user
object
required
​
expiresAt
number
required

Format is a unix-based timestamp. When set, this will be the expiration timestamp on the JWT sent using either the jwt field or a response httpOnly cookie set by the server.

Example:

"1715620310"

​
nextView
enum<string>
required
Available options:
done,
verify-email,
verified-and-transferred,
verify-sms
​
mfaToken
string

Token used to continue multi-factor authentication flow

​
jwt
string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

Example:

"jwt_value"

​
minifiedJwt
string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

Example:

"jwt_value"

​
elevatedAccessToken
string

Encoded JWT token for elevated access. This will only be returned when requestedScopes are requested.

Example:

"jwt_value"

​
emailVerification
object
​
smsVerification
object
Last modified on July 24, 2026