Skip to main content
PATCH
Update the authenticated user

Authorizations

Authorization
string
header
required

Session token as Authorization: Bearer (the CLI and scripts).

Body

application/json
name
string
required

Display name

Required string length: 1 - 255
Example:

"Ada Lovelace"

Response

The updated user

id
string
required

User id

Example:

"k5vY2..."

email
string<email>
required

Verified sign-in email

Example:

"ada@example.com"

name
string
required

Display name

Example:

"Ada Lovelace"

emailVerified
boolean
required

Whether the email is verified

role
string | null
required

Platform role; user for every regular account

Example:

"user"

image
string | null
required

Avatar URL, if any