Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Employee Tables
Public API

Update Table Row (v1)

Deprecated. Use Update Table Row (v1.1) instead (update-table-row-v1-1). Update an existing row in the specified employee table by submitting field name/value pairs for the fields to change in JSON or XML.

OAuth Scopes: employee.write, employee:assets.write, employee:compensation.write, employee:custom_fields.write, employee:custom_fields_encrypted.write, employee:education.write, employee:emergency_contacts.write, employee:job.write, sensitive_employee:creditcards.write

post/api/v1/employees/{id}/tables/{table}/{rowId}

Path parameters

idstring required

The employee ID.

tablestring required

The API name of an employee table. Standard table names: jobInfo, jobInformation, compensation, employmentStatus, contacts, emergencyContacts, dependents, earnings, bonus, commission, benefit_class, employeeVisas, employeeEducation, employeePassports, employeeDriverLicenses, employeeCertifications, employeeStockOptions, employeeAssets, employeeCreditCards, employeeCovidTests, employeeCovidVaccinations, employeeCovidVaccinationExemptions, employeeCovidExposures, employeeEquityGrants, levelsAndBands, employeeProjectPayRates. Custom company-defined tables also accepted — they use a numeric suffix (e.g., custom1, custom42). Use the list-tabular-fields tool (GET /api/v1/meta/tables) to discover custom table names for a specific company.

Example:employeeEducation

The API name of the table containing the row to update. See the TableName schema for valid standard values; custom tables use a custom prefix. Use GET /api/v1/meta/tables to discover the complete list.

rowIdstring required

The ID of the row to update.

Request body

datestring date

The effective date for the row in YYYY-MM-DD format.

locationstring

The employee location value for the row.

divisionstring

The division value for the row.

departmentstring

The department value for the row.

jobTitlestring

The job title value for the row.

reportsTostring

The manager or reports-to value for the row.

teamsstring[]

Team values associated with the row.

Response

Row updated successfully. A 200 response is returned as long as at least one field was updated, even if some fields were skipped due to permissions. No response body is returned.