Patch Worker

patch

https://example.com/api/v1/workers/{workerId}

Patches specific supplied properties for a worker by unique ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Creates a new worker using supplied attributes. Accepted attributes are listed in the body parameters section below.

Path Params

workerId

int32

required

The unique worker ID

Body Params

New worker details

externalId

string | null

External Id

isIndependentContractor

boolean | null

Is independent contractor

contractorDetails

object | null

Contractor details
Required if EasyPayroll.Domain.Models.V1.Worker.WorkerPatchDto.IsIndependentContractor is set to true.

physicalAddress

object | null

Physical address

postalAddress

object | null

Postal address

holidayRegionId

int32 | null

Holiday Region ID

customList1

string | null

Custom List 1 value

customList2

string | null

Custom List 2 value

customField1

string | null

Custom Field 1

customField2

string | null

Custom Field 2

firstName

string | null

First name

middleName

string | null

Middle name

lastName

string | null

Last name

emailPersonal

string | null

Email personal

emailWork

string | null

Email work

mobile

string | null

Mobile

workPhone

string | null

Work Phone

dob

date-time | null

Date of birth

gender

string | null

enum

Gender

Allowed:

Responses

400

If invalid inputs have been supplied

404

If worker is not found

Language

Credentials

http

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Patch Worker

What’s Next

What’s Next

200Returns a success response

What’s Next

What’s Next