Sign in

v1

latestOpenAPI 3.0.32026-07-17542197.8 KB
User

Update user

Update the given user.

patch/v1/users/{id}

Request body

usernamestring

The unique username of the user.

first_namestring

First name of the user.

last_namestring

Last name of the user.

emailstring email

Email address of the user.

passwordstring password

Password of the user. Required together with the new_password field.

new_passwordstring password

New password of the user.

picturestring uri nullable

Profile picture of the user.

titlestring nullable

Work title of the user.

biostring nullable

Self description of the user.

addressstring nullable

Working address of the user.

phonestring nullable

Phone number of the user.

linksstring[]

Links to show on profile page.

languagesLanguage[]

Languages of the user.

status'active' | 'pending' | 'inactive' | 'deleted'

Status of the user.

Example request

{
  "username": "test-user",
  "first_name": "Test",
  "last_name": "User",
  "email": "user@example.com",
  "password": "super-secret",
  "new_password": "super-secret",
  "picture": "https://example.com/users/my-user.png",
  "title": "Senior Software Engineer",
  "bio": "I'm working smart on software.",
  "address": "Remote",
  "phone": "+15555551234",
  "links": [
    "https://example.com/my-user"
  ],
  "status": "active"
}

Response

OK

idstring required

Unique identifier of the user.

usernamestring required

The unique username of the user.

first_namestring required

First name of the user.

last_namestring required

Last name of the user.

emailstring email required

Email address of the user.

picturestring uri nullable required

Profile picture of the user.

titlestring nullable required

Work title of the user.

biostring nullable required

Self description of the user.

addressstring nullable required

Working address of the user.

phonestring nullable required

Phone number of the user.

linksstring[] nullable required

Links to show on profile page.

languagesLanguage[] required

Languages of the user.

status'active' | 'pending' | 'inactive' | 'deleted' required

Status of the user.

created_atstring date-time required

Date when the user was created.

updated_atstring date-time nullable required

Date when the user was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "username": "test-user",
  "first_name": "Test",
  "last_name": "User",
  "email": "user@example.com",
  "picture": "https://example.com/users/my-user.png",
  "title": "Senior Software Engineer",
  "bio": "I'm working smart on software.",
  "address": "Remote",
  "phone": "+15555551234",
  "links": [
    "https://example.com/my-user"
  ],
  "status": "active"
}