Skip to main content
PATCH
Update account

Body

application/json

Request payload to update an account.

Request payload to update an account.

displayName
string

New display name (2-32 characters).

Required string length: 2 - 32
emailAddress
string<email>

New email address (must be valid email format).

Required string length: 5 - 254
password
string

New password (will be hashed before storage).

Required string length: 8 - 128
username
string

New account handle.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

Represents an account.

Represents an account.

createdAt
string<date-time>
required

Timestamp when the account was created.

emailAddress
string
required

Email address associated with the account.

isActivated
boolean
required

Whether the account email has been verified.

isAdmin
boolean
required

Whether the account has administrator privileges.

isSuspended
boolean
required

Whether the account is currently suspended.

updatedAt
string<date-time>
required

Timestamp when the account was last updated.

username
string
required

Public handle of the account.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
avatarUrl
string

Serve path of the account's avatar, when set.

displayName
string

Display name of the account holder, when set.