Create

post

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

Creates a user in your account. firstName, lastName and email are required; every other field falls back to its default. If single sign-on is disabled for the account and the user is created with active: true, an invitation email is sent. If the email address already belongs to a user of your account, no new user is created: when you supply a cuid and that user has no CUID yet (or the same one), the CUID is attached and the existing user is returned unchanged. Any other case is rejected as a conflict. Activating a user consumes a license — the request fails if none is free.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Defaults to false

admin

boolean

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

UI language of the user. Defaults to the account locale, or en if the account has none.

Allowed:

cuid

string

Your own identifier for this user. Must match ^[a-zA-Z0-9._-]+$ and be unique within the account. May be used in place of the desk.ly ID in later requests.

assignedLocations

array of strings

IDs of the locations a manager or analyst has access to. Ignored for users without one of those roles. Unknown IDs are ignored.

assignedLocations

teams

array of strings

IDs of the teams the user belongs to. Ignored when permissionGroups is also sent. Requires permission groups to be enabled for the account. Unknown IDs are ignored.

teams

201201

401401