API Reference

Update of existing Employee record

patch
https://api.worklio.com/wep/companies//employees/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
int32
required
Body Params
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

Updated 7 months ago

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

Updated 7 months ago