>>

Edit User

This route requires a valid Authorization header.

PATCH/users

Modify your user account.

>>

Request Body
FieldTypeDescription
passwordStringThe user’s current password for validation.
username?StringThe user’s new username.
email?StringThe user’s new email.
new_password?StringThe user’s new password.
>>

Response

200User

FieldTypeDescription
idNumberThe user’s ID.
usernameStringThe user’s username. This field has to be between 2 and 32 characters long.
display_name?StringThe user’s display name. This field has to be between 2 and 32 characters long.
social_creditNumberThe user’s social credit score.
statusStatusThe user’s status.
bio?StringThe user’s bio. The upper limit is the instance’s Instance Info bio_limit.
avatar?NumberThe user’s avatar. This field has to be a valid file ID in the “avatar” bucket.
banner?NumberThe user’s banner. This field has to be a valid file ID in the “banner” bucket.
badgesNumberThe user’s badges as a bitfield.
permissionsNumberThe user’s instance-wide permissions as a bitfield.
email?StringThe user’s email. This is only shown when the user queries their own data.
verified?BooleanThe user’s verification status. This is only shown when the user queries their own data.
>>

Example

 
curl \
  -H "Authorization: <token>" \
  -X PATCH
  --json '{"email":"[email protected]","username":"nicolas"}'
  https://api.eludris.gay/users

{
  "id": 2346806935553
  "username": "nicolas"
  "display_name": "HappyRu"
  "social_credit": 0,
  "bio": "I am very happy!"
  "badges": 0,
  "permissions": 0
}