PATCH
/
ats
/
candidates
/
{candidate_id}
/
integration-fields
/
{integration_field_id}
curl --request PATCH \
  --url https://api.kombo.dev/v1/ats/candidates/{candidate_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": "success",
  "data": {}
}

This endpoint requires the permission Write custom fields on candidates to be enabled in your scope config.

​
Example Request Body

{
  "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

​
candidate_id
string
required

The Kombo ID of the Candidate you want to update.

​
integration_field_id
string
required

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

Body

application/json

PATCH /ats/candidates/:candidate_id/integration-fields/:integration_field_id request body

The body is of type object.

Response

200
application/json

PATCH /ats/candidates/:candidate_id/integration-fields/:integration_field_id Successful response

The response is of type object.