Skip to main content
PATCH
Update employment compensation
Closed Beta Feature: This endpoint is now in closed beta. Please reach out to your account manager or support.
First, get the update form. Use the returned field keys. Include required fields and any fields you want to change. Omitted fields stay unchanged; null clears a value.
This endpoint requires the permission Create and manage employees to be enabled in your scope config.

Example Request Body

Authorizations

Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

employment_id
string
required

The Kombo ID or the HRIS ID of the employment. Find it in employments on the employee, or with Get employments.

Example:

"remote:67890"

Body

application/json

PATCH /hris/employments/:employment_id/form/compensation Request body

properties
object
required

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.

Response

PATCH /hris/employments/:employment_id/form/compensation Positive response

status
string
required
Allowed value: "success"
data
object
required
Example: