Skip to content
Fleet Fleet Platform API

Update a user

PATCH
/users/{user_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
user_id
required

User id

string
/^[1-9]\d*$/
Example
42

Request Body

Section titled “Request Body ”
object
email

New work email. Same validation as create; must not belong to another active user when changed.

string format: email
Example
[email protected]
first_name

Given name. Omit for no change; null clears when supported.

string
nullable
Example
Ada
last_name

Family name. Omit for no change; null clears when supported.

string
nullable
Example
Lovelace
phone

Contact phone; spaces are removed. Omit for no change; null clears when supported.

string
nullable
Example
+33123456789
phone_country

Omit for no change; null clears when supported.

string
nullable
Example
FR
password

New password: only a non-empty string updates the login password (hashed server-side). Omit for no change; null does not clear an existing password.

string
nullable
Example
hunter2
language

Preferred UI language. Omit for no change; null clears when supported.

string
nullable
Example
fr
position

Job title. Omit for no change; null clears when supported.

string
nullable
Example
Software engineer
arrival_date

Employment start. Omit for no change; null clears when supported.

string
nullable
Example
2024-01-15
departure_date

Employment end. Omit for no change; null clears when supported.

string
nullable
Example
2026-12-31
date_of_birth

Date of birth. Omit for no change; null clears when supported.

string
nullable
Example
1990-05-21
city_of_birth

City of birth. Omit for no change; null clears when supported.

string
nullable
Example
Paris
country_of_birth

Country of birth. Omit for no change; null clears when supported.

string
nullable
Example
FR
role

EMPLOYEE: standard company user. ADMIN: can manage company configuration and users in Fleet. On create, defaults to EMPLOYEE when omitted.

string
Allowed values: EMPLOYEE ADMIN
Example
EMPLOYEE

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated user

object
data
required
object
id
required
integer
company_id
required
integer
email
required
string
nullable
first_name
required
string
nullable
last_name
required
string
nullable
phone
required
string
nullable
phone_country
required
string
nullable
language
required
string
nullable
position
required
string
nullable
role
required

EMPLOYEE: standard company user. ADMIN: can manage company configuration and users in Fleet. On create, defaults to EMPLOYEE when omitted.

string
Allowed values: EMPLOYEE ADMIN
Example
EMPLOYEE
arrival_date
required
string
nullable
departure_date
required
string
nullable
date_of_birth
required
string
nullable
city_of_birth
required
string
nullable
country_of_birth
required
string
nullable