Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Employee

Patch Employee

Patches employee given its profile_id. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

patch/api/v2/core/employees/{profileId}

Path parameters

profileIdstring required

Eightfold employee profile ID (supports both encoded and decoded)

Headers

Authorizationstring required

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

Request body

employeeTypestring nullable

Type of the employee

locationCountrystring nullable

The location country of the employee

managerEmailstring nullable

The email of the manager

positionCriticalitystring[] nullable

The criticality of the position of the employee

isContingentboolean nullable

Is contingent

locationstring nullable

The location of the employee

firstNamestring nullable

First Name of the employee

bustring nullable

The Business unit of the employee

emailstring required

List of Emails of the employee comma seperated

levelstring nullable

The job level of the employee

userIdstring nullable

The userId of the employee

businessEmailstring nullable

The business email of the employee

externalJobIdstring nullable

External job id of the employee

lastReviewRatingstring nullable

The last review rating of the employee

customInfoobject nullable

The custom info captured for the employee by custom fields

employeeIdstring required

The unique id of the Employee in the HRIS system

systemIdstring nullable

Integration system id for the employee

companyNamestring nullable

The company name of the employee

phonestring nullable

The phone number of the employee

titlestring nullable

The title of the employee

idstring nullable

Profile id of the Employee in Eightfold

managerUserIdstring nullable

The user id of the manager in HRIS system

lastUpdatedTsinteger nullable

The last updated timestamp of the employee profile

managerContactEmailstring nullable

The contact email of the manager

lastActivityTsinteger nullable

The last activity timestamp in seconds

hiringTsinteger nullable

The hiring timestamp of the employee in seconds

terminationTsinteger nullable

The termination timestamp of the employee in seconds

managerFullnamestring nullable

The full name of the manager

jobCodestring nullable

The job code of the employee

roleChangeTsinteger nullable

The last role timestamp of the employee in seconds

lobstring nullable

The lob of the employee

rolestring nullable

The role of the employee

eligibleForTransferboolean nullable

Is the employee eligible for transfer or not

lastNamestring nullable

Last Name of the employee

personalEmailstring nullable

The personal email of the employee

Response

OK

transactionIdstring nullable