Patch User

patch

https://apiv2.{domain}.ai/api/v2/core/users/{userId}

Given a user id of a user with user data, it patches the user object. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userId

string

required

EF Entity ID of user

Query Params

include

string

Include additional fields in the response. Possible values are lastLoginTimeStamp

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Body Params

uuid

string | null

External unique identifier such as UUID, Corporate ID and Employee ID

rmUserGroups

array of objects | null

RM user groups associated with the user

rmUserGroups

timezoneName

string | null

timezone name fr a user

timezoneOffset

int32 | null

timezone offset for a User

roles

array of strings | null

Roles of a user

roles

profileId

string | null

ProfileId of User

defaultAccessMode

string

required

Access Mode of User

isDisabled

boolean | null

Email of User

atsData

object | null

Ats Data of an User

firstName

string | null

First Name of User

company

string | null

company of User

hrbpData

object | null

HRBP Data of an User

lastName

string | null

Last Name of User

title

string | null

title of User

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK