This endpoint allows you to create a new employee in the system.
The request body must include the minimum required fields: email, firstName, surname, and the work object with site and startDate.
While not all fields are mandatory, we recommend populating as many fields as possible to ensure complete employee records from the start.
Specifically, it's recommended to include work.department and work.title.
You can include any additional fields from the Fields Metadata API to enrich the employee's profile during creation.
Important Notes
Recently updated employee data may take a few seconds to become available when fetching data. If you read immediately after an update, the response may still show the previous value or null. Wait up to 20 seconds before a follow-up read. See Read-after-update consistency.
Bad request. The request contains incorrect parameters or syntax errors. Please review the request body
Forbidden. The service user does not have permissions to access this table or employees. Check the permissions as explained in the endpoint description.
"Too Many Requests" error. This indicates that you've exceeded the rate limit for requests. Please verify that you are using the correct endpoint with the POST method. Additionally, check the HTTP headers for rate limit information, such as the number of requests allowed and the time until the limit resets. For more details, see Rate Limiting.