Update an employee

PUT
/employees/:employee_id

Updates the specified employee by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the email parameter only the email value will be changed.

Note that the home_address field is treated as single object that is updated entirely. If you provide this field, the entire address object will be replaced with the new data, not just the individual sub-fields you include in the request, potentially removing any sub-fields you didn’t include in the request.

This request accepts mostly the same arguments as the employee creation call.

Path parameters

employee_idstringRequired

Request

This endpoint expects an object.
first_namestringOptional
last_namestringOptional
home_addressobjectOptional

Treated as a single object that is updated entirely, null sub-fields (e.g. Line 3) will delete the existing values

nationalityenumOptional
national_tax_idstringOptional

National tax ID, e.g. PPSN in Ireland, NINO in the UK, DNI/NIE in Spain

phone_numberstringOptional

Phone number in E.164 international format (e.g. +447700900999)

emailstringOptional
bank_accountobjectOptional

Treated as a single object that is updated entirely.

Response

OK

first_namestring
last_namestring
date_of_birthstringformat: "date"
sex_at_birthenum
Allowed values: malefemale
national_tax_idstring
phone_numberstring
emailstring
platform_idstringOptionalformat: "pt_.+"
idstringOptionalformat: "ee_.+"
employer_idstringOptionalformat: "er_.+"
statusenumOptional
Allowed values: pendingactiveoffboardinginactiverestricted
external_customer_idstringOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.

home_addressobjectOptional
nationalityenumOptional
start_onstringOptionalformat: "date"
offboard_ondatetimeOptional
bank_accountobjectOptional
objectstringOptional

The object type

Built with