Create

post

https://app.desk.ly/{locale}/api/v2/user/new

This API endpoint enables an authorized admin, authenticated through a valid API key, to add new users to the account. The admin can provide essential details such as the user's name, email, and role. Upon successfully creating the user, an email is automatically sent to the user, notifying them of their new account.

Path Params

locale

string

required

Defaults to en

The locale to provide translated error messages

Body Params

firstName

string

required

lastName

string

required

string

required

active

boolean

required

Defaults to false

admin

boolean

required

Defaults to false

manager

boolean

Defaults to false

analyst

boolean

Defaults to false

timezone

string

Defaults to Europe/Berlin

locale

string

enum

Defaults to en

Allowed:

cuid

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

201201

401401