Candidates
Update fields on Candidates
Update writable integrations fields on Candidates in the remote system.
PATCH
/
ats
/
candidates
/
{candidate_id}
/
integration-fields
/
{integration_field_id}
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
headerrequiredCreate an API key on the Secrets page in the Kombo dashboard.
Headers
X-Integration-Id
string
requiredID of the integration you want to interact with.
Path Parameters
candidate_id
string
requiredThe Kombo ID of the Candidate you want to update.
integration_field_id
string
requiredThe Kombo ID of the integration field you want to update.
Body
application/json
value
required
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success
data
object
required