Skip to content

Delete a user

DELETE
/users/{user_id}
user_id
required

User id

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

Deleted user

object
data
required
object
id
required
integer
email
required
string
nullable
secondary_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. 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
teams
required

Teams the user belongs to, sorted by label.

Array<object>
object
id
required
integer
label
required
string

Deletion blocked because this user is a purchaser on at least one order and no other eligible purchaser exists in the company.

object
error
required
string
Allowed values: USER_DELETE_BLOCKED