PUT
/
v1
/
users
/
{uid}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uid
string
required

The UID of the User

Body

application/json
department_uid
string | null

A tag UID of kind "department"

first_name
string | null
gender
enum<string> | null
Available options:
female,
male,
non_binary,
other,
prefer_not_to_disclose
hire_date
string | null
job_leave_date
string | null
job_start_date
string | null
job_title
string | null
last_name
string | null

A tag UID of kind "legal_entity"

office_location_uid
string | null

A tag UID of kind "office_location"

preferred_language
string | null

A language in IETF format (en-US, pt-PT, fr-FR...)

report_to_uid
string | null

The UID of the manager of this user

team_uids
string[]

An array of tag UIDs of kind "team"

work_phone
string | null

Response

200 - application/json
created_at
string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

department_uid
string | null

A tag UID of kind "department"

emails
string[]

An array of all the known emails for this User.

first_name
string | null
full_name
string | null

The full name of the User.

gender
enum<string> | null
Available options:
female,
male,
non_binary,
other,
prefer_not_to_disclose
hire_date
string | null
job_leave_date
string | null
job_start_date
string | null
job_title
string | null
last_name
string | null

A tag UID of kind "legal_entity"

microsoft_entra_ids
string[]

The Microsoft Entra IDs (Azure Directory) of the User.

office_location_uid
string | null

A tag UID of kind "office_location"

preferred_language
string | null

A language in IETF format (en-US, pt-PT, fr-FR...)

report_to_uid
string | null

The UID of the manager of this user

role_name
enum<string>

The role of the User.

Available options:
owner,
admin,
it,
hr,
ops,
finance,
custom,
user
slack_user_id
string | null

The Slack user ID of the User (e.g. U0G9QF9C6).

status
enum<string>
default:
employee

The status of the User.

Available options:
hired,
employee,
alumni,
external
team_uids
string[]

An array of tag UIDs of kind "team"

timezone
string | null
uid
string

The UID of the User.

updated_at
string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

work_phone
string | null