Skip to main content
This feature is now in closed beta. Please reach out to your account manager or support.

Overview

Update Employment changes data that belongs to one employment of an employee. Get the fields the HRIS accepts, collect the required values and any changes, then submit them. To change the employee’s own details, use Update Employee. Which fields each form has depends on the HRIS and how the company set it up.

Implementation Steps

1

Find the employment

Each employee lists their employments in employments on Get employees. You can also use Get employments. An employee with more than one employment needs one request per employment you want to change.employment_id accepts the Kombo ID or the HRIS ID with a remote: prefix.
2

Get the form

GET the form for your change:If the HRIS can’t make this change, you get INTEGRATION.ACTION_NOT_AVAILABLE, so you can hide the option in your UI.When available, current_value contains the field’s current value in the HRIS for this employment. Use it to prefill the form. null means the field is empty. If the HRIS doesn’t let us read a field, current_value is left out.
Example Response
3

Submit changes

PATCH the values in properties to the same URL:Use the field keys returned by GET. Include required fields and any fields you want to change. Omitted fields stay unchanged; null clears a value.
Example Request
  • Options listed in the form accept the option id or remote:<remote_id>. For options returned by a linked endpoint (options.type: "referenced"), use the Kombo ID.
  • Dates use YYYY-MM-DD. Whether a past date is allowed depends on the HRIS.
Requires the Create and manage employees permission in your scopes.
4

Read the response

Example Response
  • id: The Kombo ID of the employment.
  • remote_id: The ID of the employment in the HRIS.
A success response means the HRIS saved the change, and Kombo updates its copy of the employment right away.

Displaying the Form

Reuse your create employee form display code. Submit values using the keys returned by the update form. This guide explains field types and mapping.