Update

This API endpoint allows an authorized admin, authenticated through a valid API key, to update details of a specific user associated with the account. By providing the user's unique identifier, the admin can modify information such as the user's name and email address.Each body parameter is optional. This endpoint can be used to make a full replacement of a users data. Omitted fields reset to defaults. To update only some fields use the User Patch endpoint instead. Using additional / unknown attributes will throw an error, which gives back a list of allowed attributes.

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
required
string
required
string
required
boolean
required
Defaults to false
boolean
required
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
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.

assignedLocations
array of strings

Array of location ids a analyst or manager has access to.

assignedLocations
teams
array of strings

Array of team ids to directly assign a user to a existing team.

teams
tags
array of strings

Array of tag ids to assign to the user.

tags
licensePlates
array of strings

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

licensePlates
permissionGroups
object

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

Responses

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