Improved
Employee API: added status field
over 2 years ago by Public API Support
Added the feature to set/update Employee's Status.
We also added the feature to set/update Employee Status using the Public API on the POST and PATCH endpoints.
Include the status in the request body with the value that you wish to set, one of: "active", "onboarding", "leave", "inactive".
Notes:
- If the
statusfield is not in the request body, the value will not be affected. - If the
statusto be assigned is not recognized, an error response with status 422 will be returned. - In the
POSTmethod (creation of an Employee),statusis usually determined based on thehire_date. If you don't supplystatus, it stays like that. If you supplystatus, it will override the value determined based on thehire_date. - In the
PATCHmethod (update of an Employee),hire_datewill not cause automatic update of thestatusfield. This is the old behavior and it remains unchanged.
For more details, check the documentation on how to create or update an employee using the Public API.
