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.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"

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
earliest_benefits_start_datestring or nullOptionalformat: "date"
The earliest date this employee can be enrolled in any benefits. Before this date, the employee remains in a Pending state and is excluded from benefit activation. **Constraints:** - On update, may only be changed if no policy or offer exists for this employee. - Must be a valid date. - Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.
bank_accountobject or nullOptional
Treated as a single object that is updated entirely.
metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. 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"
earliest_benefits_start_datestring or nullformat: "date"
offboard_onstring or nullformat: "date-time"
bank_accountobject or null
metadatamap from strings to strings or null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstring or null
The object type

Errors