Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Employee Tables

Update a work entry in the employee's work history table.

This endpoint updates an entry in the employee’s work history table.<br> The unique identifier for the work entry is the site and effective date.<br> <p>Note that the entire work entry will be overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).</p> <b>Patch Update Flag</b>:<br> As a best practice, we recommend reading the entire work entry data, updating the necessary fields, and then writing back the entire entry. However, for legacy purposes, we provide the flag: patchUpdate=true, which functions similarly to a PATCH request. <br> When using this flag, please note:<br> 1. Only the fields included in the payload will be updated; all others will remain unchanged.<br> 2. The identifier for the work entry should be entry_id, not the site/effective date.<br> 3. Note that using the patchUpdate approach is not recommended and should be reserved for legacy implementations only.

put/people/{id}/work/{entry_id}

Path parameters

idstring required

The ID of the employee you are updating. This can be the Employee ID from the URL in the user interface or the id field returned when retrieving an employee's data.

entry_idinteger required

The ID of the entry in the work table which you are updating. To obtain the work entry use the GET /people/{id}/work endpoint.

Request body

idinteger

The ID of the work entry.

reasonstring

The reason for this change.

effectiveDatestring date required

The date this entry becomes effective. This is a mandatory field for a work entry.

titlestring

The job title of the employee for this work entry. This field should contain the ID of the job title entry from the job title list.

departmentstring

The department the employee belonged to for this work entry. This field should contain the ID of the department entry in department list.

sitestring

The site of the employee. This is a mandatory field for a work entry (you must pass either the site or the siteId).

siteIdinteger

The id of the site of the employee. This is a mandatory field for a work entry (you must pass either the site or the siteId).

customColumnsobject

Response

Entry updated successfully.