v1

latestOpenAPI 3.0.02026-07-24990169.2 KB

Update user information

Requires scope user:write.

patch/users/{id}

Path parameters

idnumber required

User ID

Request body

namestring

New user name

emailstring

New user email address

role'editor' | 'admin'

New user role. Can only be changed by admins.

languagestring

New language preference.

activateTokenstring

Activate token, typically used to unset it when activating user.

passwordstring

Strong user password.

oldPasswordstring

The previous user password.

presenceColorstring

The preferred color to use for user presence pin.

avatarstring

'' sets the avatar to fallback, while null sets avatar to custom_avatar.

emailNotificationsboolean

Enable or disable email notifications.

oauthSigninfalse

Setting this to false disconnects any oauth signin providers connected to user account.

Example request

{
  "name": "Carol Danvers",
  "email": "89P13@half.world",
  "language": "en_US",
  "password": "13-binary-1968"
}

Response

Successful