Update an employee's fields by submitting a JSON object or XML document containing field name/value pairs. The request body schema lists commonly used fields, but any valid employee field name may be used as a key. To discover available field names, call the list-fields endpoint (operationId: list-fields, GET /api/v1/meta/fields).
Trax Payroll note: If the employee is currently on a pay schedule syncing with Trax Payroll, or is being added to one, the request must include the required payroll-related employee fields: employeeNumber, firstName, lastName, dateOfBirth, ssn or ein, gender, maritalStatus, hireDate, address1, city, state, country, employmentHistoryStatus, exempt, payType, payRate, payPer, location, department, and division.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Employee updated successfully. No response body is returned.
Provided JSON is malformed, or required fields are missing.
The API user does not have permission to see the employee or to update any of the requested fields.
The employee does not exist.
A field was given an invalid value (e.g., duplicate email, invalid state/country, incompatible pay type).