Patch HRIS Employee

patch

https://apiv2.{domain}.ai/api/v2/core/hris-systems/{systemId}/ext-employees/{employeeId}

Patches employee given its employee id. 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

systemId

string

required

System ID of profile. Use default if you have only one system and dont want to use system-Id.

employeeId

string

required

Employee unique Id

Body Params

employeeType

string | null

Type of the employee

locationCountry

string | null

The location country of the employee

candidateData

object | null

candidate data of employee

managerEmail

string | null

The email of the manager

positionCriticality

array of strings | null

The criticality of the position of the employee

positionCriticality

isContingent

boolean | null

Is contingent

location

string | null

The location of the employee

badges

array of objects | null

The badges of the employee

badges

firstName

string | null

First Name of the employee

mobility

object | null

The mobility of the employee

string | null

The Business unit of the employee

string

required

List of Emails of the employee comma seperated

temporalFields

array of objects

Temporal fields of the employee

temporalFields

basePay

object | null

The base pay of the employee

level

string | null

The job level of the employee

rmUserGroups

array of objects | null

RM user groups associated with the employee

rmUserGroups

userId

string | null

The userId of the employee

businessEmail

string | null

The business email of the employee

externalJobId

string | null

External job id of the employee

lastReviewRating

string | null

The last review rating of the employee

customInfo

object | null

The custom info captured for the employee by custom fields

employeeId

string

required

The unique id of the Employee in the HRIS system

systemId

string | null

Integration system id for the employee

employeeCriticality

object | null

The criticality information of the employee

companyName

string | null

The company name of the employee

phone

string | null

The phone number of the employee

performanceRatings

array of objects | null

Performance ratings for the employee

performanceRatings

languages

array of objects | null

The employee language proficiencies

languages

title

string | null

The title of the employee

managerUserId

string | null

The user id of the manager in HRIS system

successionPlan

object | null

Succession plan for the employee

bonus

object | null

The bonus given to the employee

managerContactEmail

string | null

The contact email of the manager

lastActivityTs

int32 | null

The last activity timestamp in seconds

hiringTs

int32 | null

The hiring timestamp of the employee in seconds

terminationTs

int32 | null

The termination timestamp of the employee in seconds

managerFullname

string | null

The full name of the manager

jobCode

string | null

The job code of the employee

roleChangeTs

int32 | null

The last role timestamp of the employee in seconds

lob

string | null

The lob of the employee

role

string | null

The role of the employee

eligibleForTransfer

boolean | null

Is the employee eligible for transfer or not

lastName

string | null

Last Name of the employee

personalEmail

string | null

The personal email of the employee

Headers

Authorization

string

required

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

Response

200OK