Approval Workflow2

Async API Status1

ATS Candidate5

ATS Position6

Booking7

Career Navigator2

Careerhub5

Comment9

Course5

Demand7

Email Delivery Feedback3

Employee12

Employee Role2

Entity Changelog1

Entity Profile Application3

Event Candidate Activity3

Events3

Ext AI Interview3

Ext Booking5

Ext Demand7

Ext Demand Org Unit3

Foundational Data4

Hiring Company2

Holiday7

HRIS Employee2

Insights3

JIE6

Join Talent Pool1

Offer6

Org Unit1

Performance Feedback4

Position9

Profile12

Profile Application3

Profile Feedback3

Profile Note4

Profile Tag4

Question2

Succession Plan12

Upskill Plan Assignment8

Upskill Plan Template8

User Calendar Event3

User Campaign3

User Groups8

User Message3

Users6

Users

Patch User

Changed on Nov 3, 2026

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.

patch/api/v2/core/users/{userId}

Request

Base URL
https://apiv2.eightfold.ai
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/users/:userId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

EF Entity ID of user

Query parameters

includestring

Include additional fields in the response. Possible values are lastLoginTimeStamp

excludestring

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.

keyListstring

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.

Headers

Authorizationstring required

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

Request body

uuidstring nullable

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

efUserGroupsstring[] nullable

EF User Group names to statically set this user to (full replace)

timezoneNamestring nullable

timezone name fr a user

timezoneOffsetinteger nullable

timezone offset for a User

rolesstring[] nullable

Roles of a user

profileIdstring nullable

ProfileId of User

defaultAccessModestring required

Access Mode of User

isDisabledboolean nullable

Email of User

firstNamestring nullable

First Name of User

companystring nullable

company of User

hrbpDataobject nullable

HRBP Data of an User

lastNamestring nullable

Last Name of User

titlestring nullable

title of User

Response

verifiedAtinteger nullable

Verified at timestamp of the User

createdAtinteger nullable

Create timestamp of the User

managerEmailstring nullable

Email of User's Manager

rolesstring[] nullable

Roles of a user

profileIdstring nullable

ProfileId of User

firstNamestring

First Name of User

companystring nullable

Company of User

emailstring required

Email of User

timezoneNamestring nullable

Timezone name for a user

localLoginEnabledboolean nullable

Whether password/local login is enabled for the user

defaultAccessModestring

Access Mode of User

titlestring nullable

Title of User

idstring nullable

Id of an User

languagestring nullable

Language preference of the user

timezoneOffsetinteger nullable

Timezone offset for a User

updatedAtinteger nullable

Update timestamp of the User

hrbpDataobject nullable

HRBP Data of an User

uuidstring nullable

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

isDisabledboolean nullable

If user is disabled or not

lastLoginTimeStampinteger nullable

Last login time stamp of a user

ssoEnabledboolean nullable

Whether SSO is configured/enforced for the user

managerstring nullable

Manager of User

lastNamestring