Sign in
users

Update User

Update an existing user. Requires System Admin.

put/api/v1/users/{user_id}

Path parameters

user_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

emailstring email nullable
first_namestring nullable
last_namestring nullable
rolestring nullable

Legacy free-text role (deprecated)

user_role_idinteger nullable

FK to user_roles table

is_activeboolean nullable
is_adminboolean nullable
timezonestring nullable

IANA timezone name, e.g. 'Asia/Singapore'

custom_fieldsobject nullable

Per-tenant custom field values

Response

Successful Response

idinteger required
usernamestring required
emailstring required
first_namestring nullable
last_namestring nullable
rolestring nullable
user_role_idinteger nullable
user_role_namestring nullable
is_activeboolean required
is_adminboolean
last_loginstring date-time nullable
custom_fieldsobject

Changes

No recorded changes to this endpoint across all 5 revisions of this API.