Skip to main content
PATCH
/
ats
/
candidates
/
{candidate_id}
/
integration-fields
/
{integration_field_id}
Update fields on Candidates
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": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}
This feature is currently available for the following integrations:
    You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
    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

    ​
    value
    required

    Response

    PATCH /ats/candidates/:candidate_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.

    ⌘I