API Reference
  1. DeskDay API
  2. Users

Update a user

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

Update a user. Requires scope users:write.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User mapping_id.

Body Params
string
length ≤ 254

User email address.

string
length between 2 and 50

Full name; when provided, takes priority over first_name/last_name.

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
enum

Activation status to set on the user.

Allowed:
boolean

Whether to send a customer portal invite email.

string
enum

Portal role to grant the user.

Allowed:
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.

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?