PATCH
/
hris
/
employees
/
{employee_id}
/
integration-fields
/
{integration_field_id}
Update fields on Employees
curl --request PATCH \
  --url https://api.kombo.dev/v1/hris/employees/{employee_id}/integration-fields/{integration_field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "value": "New integration field value!"
}'
{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}
This endpoint requires the permission Create and manage employees to be enabled in your scope config.

​
Example Request Body

{
  "employee_id": "GVQYPEDvn4dBrJxHUPuxXJ9E",
  "integration_field_id": "8icrU24RMhQo5hW3gsRY5YU9",
  "value": "New integration field value!"
}

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

​
employee_id
string
required

The Kombo ID of the Employee you want to update.

​
integration_field_id
string
required

The Kombo ID of the integration field you want to update.

Body

application/json

PATCH /hris/employees/:employee_id/integration-fields/:integration_field_id Request body

​
value
required

Response

PATCH /hris/employees/:employee_id/integration-fields/:integration_field_id Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.