Patch

Updates only the fields present in the request body and leaves everything else untouched. Sending null for a nullable field resets it to its default — that is different from omitting the field, which changes nothing. admin, manager and analyst are evaluated as one group: as soon as any of them is present, all three are re-applied, and the ones you did not send count as false. Sending {"manager": true} for an administrator therefore removes their administrator role. Send all three flags together whenever you change roles. Only one of them may be true, otherwise the request is rejected.

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

Whether the user may log in and book. Also controls the user's license assignment — activating a user consumes a license and the request fails if none is free.
If omitted: unchanged

boolean
Defaults to false

Grants full administrative access to the account. Part of the role group — see the endpoint description. The last administrator of an account cannot lose this role.
If omitted: unchanged

boolean
Defaults to false

Part of the role group — see the endpoint description.
If omitted: unchanged

boolean
Defaults to false

Part of the role group — see the endpoint description.
If omitted: unchanged

string
Defaults to Europe/Berlin
string
enum
Defaults to en
Allowed:
string

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

assignedLocations
array of strings

IDs of the locations a manager or analyst has access to. Only applied when the user holds one of those roles after this request — otherwise ignored. Unknown IDs are ignored.
If omitted: unchanged

assignedLocations
teams
array of strings

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

teams
tags
array of strings

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

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: unchanged

licensePlates
permissionGroups
object

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

string

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

Responses

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