API Reference
  1. DeskDay API
  2. Users

Create a user

post
https://public-api.deskday.ai/v1/users

Create a user (contact). Requires scope users:write. Supports X-Idempotency-Key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 64

Parent customer mapping_id. Required.

string
required
length ≤ 254

User email address. Required.

string
length between 2 and 50

Full name; when provided, takes priority over first_name/last_name and is split into first/middle/last by the webservice.

string
length between 2 and 50

User first name.

string
length between 2 and 50

User last name.

string
length ≤ 50

User contact phone number.

string
enum

User type; maps to is_privileged_user internally.

Allowed:
uuid

Site / location UUID to assign the user to.

string
length ≤ 100

User job title or designation.

string
length ≤ 100

Department the user belongs to.

string

Manager user UUID; send an empty string to clear it.

boolean
Defaults to false

Whether to send a customer portal invite email.

string
length ≤ 200

Street address line.

string
length ≤ 100

City or locality.

string
length ≤ 100

State code (e.g. "CA") or full name; resolved to a state id by the webservice.

string
length ≤ 100

Country ISO2/ISO3 (e.g. "US"/"USA") or full name; resolved to a country id by the webservice.

string
length ≤ 20

Postal or ZIP code.

string
length ≤ 200

Primary address line.

string
length ≤ 200

Secondary address line, such as a suite or unit.

string
enum
Defaults to end_user

Portal role to grant the user.

Allowed:
external_ref
object

External system reference linking the user to a third-party object.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?