For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
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_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_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
start_ondate or nullOptional
The start date of the employee.
Constraints:
On update, may only be changed if no policy or offer exists for this employee.
Must be a valid date.
The employee’s existing start_on and the new start_on date must both be in the future.
earliest_benefits_start_datedate or nullOptional
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_accountobjectOptional
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
First name of the employee. It can include the middle name
last_namestring
Last name of the employee
date_of_birthdate
Date of birth of the employee
sex_at_birthenum
The sex assigned to the employee at birth
Allowed values:
national_tax_idstring
PPSN in Ireland, NINo in the UK, DNI/NIE in Spain
phone_numberstring
Phone number in E.164 international format (e.g. +447700900999)
emailstring
Email address of the employee
platform_idstringformat: "pt_.+"
Unique identifier for the platform
idstringformat: "ee_.+"
Unique identifier for the employee
employer_idstringformat: "er_.+"
Unique identifier for the employer
statusenum
Current status of the employee
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
Location where the employee is legally registered to live
nationalityenum
Nationality of the employee (e.g. IE for Ireland, GB for United Kingdom, ES for Spain)
start_ondate
Employment start date
earliest_benefits_start_datedate or null
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. Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.
offboard_ondatetime or null
Date when the employee was or will be offboarded
bank_accountobject
Bank account details
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.
