Update

Replaces the user with the submitted representation. firstName, lastName, email and active keep their current value when omitted; every other field is reset to its default. Note that omitting cuid clears it, including when you addressed the user by that CUID — the identifier is then no longer available for later requests. The last administrator of an account cannot be demoted: a request that does not set admin: true for that user is rejected. To change individual fields, use the PATCH endpoint instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…


Path Params
string
required
Defaults to en

The locale to provide translated error messages

string
required

The ID or CUID of the user you want to edit.

Body Params
string

If omitted: unchanged

string

If omitted: unchanged

string

If omitted: unchanged

boolean
Defaults to false

If omitted: unchanged

boolean
Defaults to false

If omitted: falls back to plain user

boolean
Defaults to false

If omitted: falls back to plain user

boolean
Defaults to false

If omitted: falls back to plain user

string
Defaults to Europe/Berlin

If omitted: reset to Europe/Berlin

string
enum
Defaults to en

If omitted: reset to the account locale

Allowed:
string

Customer User Id - Can be used to map users in desk.ly directly to users of the customers system.
If omitted: cleared

assignedLocations
array of strings

Array of location ids a analyst or manager has access to.
If omitted: cleared

assignedLocations
teams
array of strings

Array of team ids to directly assign a user to a existing team.
If omitted: cleared

teams
tags
array of strings

Array of tag ids to assign to the user.
If omitted: cleared

tags
licensePlates
array of strings

Array of License Plate Strings. Not available for all customers. The license plates need to be valid license plates.
If omitted: cleared

licensePlates
permissionGroups
object

Can be used to assign the user into existing or not yet existing groups by name matching.
If omitted: cleared

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json