API ReferenceEmployees

Update an employee

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_idstringRequiredformat: "ee_.+"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
first_namestring or nullOptional
last_namestring or nullOptional
home_addressobject or nullOptional

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

nationalityenum or nullOptional
national_tax_idstring or nullOptional

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

phone_numberstring or nullOptional

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

emailstring or nullOptional
bank_accountobject or nullOptional
Treated as a single object that is updated entirely.

Response

OK
first_namestring
last_namestring
date_of_birthstringformat: "date"
sex_at_birthenum
Allowed values:
national_tax_idstring
phone_numberstring
emailstring
platform_idstring or nullformat: "pt_.+"
idstring or nullformat: "ee_.+"
employer_idstring or nullformat: "er_.+"
statusenum or null
Allowed values:
external_customer_idstring or null

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_addressobject or null
nationalityenum or null
start_onstring or nullformat: "date"
offboard_onstring or nullformat: "date-time"
bank_accountobject or null
objectstring or null
The object type

Errors