Partially updates an existing employee record.

When the request contains a Login block, the endpoint links the employee to the normalized Login e-mail. In Default LinkMode, a clean employee with Login.Email and omitted or null Login.AccessLevel is treated as EmployeeAccess provisioning. If that Default-mode request resolves an existing Login and has no filled Login.Password, the Login must already have a valid role in this company or the endpoint returns Password_required_for_existing_login_without_client_context. Existing password-set Login credentials are verified, not overwritten; mismatches return Password_does_not_match_Login_exists. Creating a new employee Login without Login.Password provisions a password-not-set account that cannot authenticate until credential setup. LinkMode LinkBySharedClientContext skips password verification only for an existing Login that already has a valid role in this company; it does not create new Logins and rejects filled Login.Password values. Additional HTTP 400 error codes for LinkBySharedClientContext are Login_not_in_client_context, Login_not_found_for_link_mode, and Password_not_allowed_with_link_mode. If the employee is already linked to another Login than the request e-mail resolves to, Employee_already_linked_to_different_login is returned.
Access: System, Admin, and ClientAdmin users only.
The endpoint applies merge-patch style semantics by using PatchValueHelper so the server can distinguish omitted properties from explicit null values.
When payroll address validation suggests a corrected address, the endpoint responds with HTTP 400 and an AddressFix_v10 payload instead of applying the update.

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

Identifier of the company that owns the employee.

int32
required

Identifier of the employee to update.

Body Params

Employee patch payload.

Employee update record.

string | null

First name.

string | null

Last name.

string | null

Middle name.

string | null

Nickname.

date-time | null

Date of birth. Data type is validated and must be Number

date-time | null

Hire date. Data type is validated and must be Number

string | null

Personal email.

string | null

Work email.

string | null

Personal phone.

string | null

Cell phone.

string | null

Work phone.

string | null

Work Cell phone.

residentialAddress
object
contract
object

Contract update record.

payAllocation
array of objects | null

Override net pay allocation.

payAllocation
login
object

Update login access level and/or password.

string | null

Meta data.

int32 | null
≥ 0

Employee UI ID (aka Employee Number).

string | null

Clock Number.

string | null

CitizenshipCountry.

int32
enum

Members:

  • 1 - USCitizen ( USCitizen. )
  • 2 - PernamentResident ( PernamentResident. )
  • 3 - ResidentAlien ( ResidentAlien. )
  • 4 - NonResidentAlien ( NonResidentAlien. )
Allowed:
string | null

Bio.

int32
enum

Members:

  • 1 - Female ( Female. )
  • 2 - Male ( Male. )
  • 3 - Other ( Other. )
Allowed:
int32 | null

Gender Identity Id

int32
enum

Members:

  • 1 - HeHimHis ( HeHimHis. )
  • 2 - TheThemTheirs ( TheThemTheirs. )
  • 3 - ZeHirHirs ( ZeHirHirs. )
  • 4 - ZeZirZirs ( ZeZirZirs. )
  • 5 - SheHerHers ( SheHerHers. )
  • 6 - Other ( Other. )
  • 7 - PreferNotToAnswer ( PreferNotToAnswer. )
Allowed:
eeo
object
driverLicence
object

Employee's Driver's License.

int32
enum

Members:

  • 1 - Single ( Single. )
  • 2 - Married ( Married. )
  • 3 - Separated ( Separated. )
  • 4 - DivorcedOrWidowed ( Divorced or Widowed. )
Allowed:
string | null

Job Description.

w2Info
object
Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json