Tags
Add tag to candidate
Add a tag to a candidate.
POST
/
ats
/
candidates
/
{candidate_id}
/
tags
Authorization
Header
Path
Body
curl --request POST \
--url https://api.kombo.dev/v1/ats/candidates/{candidate_id}/tags \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{
"tag": {
"name": "Excellent Fit"
}
}'
{
"status": "success",
"data": {}
}
Kombo takes care of creating the tag if required, finding out the right ID, and appending it to the list of tags.
This endpoint requires the permission Create and manage candidates and applications to be enabled in your scope config.
Example Request Body
{
"tag": {
"name": "Excellent Fit"
}
}
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
requiredKombo ID of the candidate you want to add the tag to.
Body
application/json
tag
object
requiredremote_fields
object
Additional fields that we will pass through to specific ATS systems.
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success
data
object
requiredcurl --request POST \
--url https://api.kombo.dev/v1/ats/candidates/{candidate_id}/tags \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{
"tag": {
"name": "Excellent Fit"
}
}'
{
"status": "success",
"data": {}
}