Sign in
Users

Update a user

Partially updates an existing user. Only provided fields are updated.

patch/users/{id}

Path parameters

idinteger required

User ID

Example:1

User ID

Request body

emailstring email

User email address

firstNamestring nullable

User first name

lastNamestring nullable

User last name

phoneNumberstring nullable

User phone number

jobTitlestring nullable

User job title

jobDepartmentstring nullable

User job department

role'user' | 'manager' | 'admin'

User role

timezonestring nullable

IANA timezone identifier

Example request

{
  "email": "jane.doe@company.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "phoneNumber": "+33612345678",
  "jobTitle": "Account Executive",
  "jobDepartment": "Sales",
  "role": "user",
  "timezone": "Europe/Paris"
}

Response

User updated

idnumber required

User ID

emailstring required

User email address

firstNamestring nullable required

User first name

lastNamestring nullable required

User last name

phoneNumberstring nullable required

User phone number

jobTitlestring nullable required

User job title

jobDepartmentstring nullable required

User job department

rolestring required

User role: user, manager, or admin

timezonestring nullable required

IANA timezone identifier

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

Example response

{
  "id": 1,
  "email": "john@example.com",
  "phoneNumber": "+33612345678",
  "jobTitle": "Account Executive",
  "jobDepartment": "Sales",
  "role": "user",
  "timezone": "Europe/Paris",
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z"
}

Changes