POST
/
ats
/
candidates
/
{candidate_id}
/
tags
Add tag to candidate
curl --request POST \
  --url https://api.kombo.dev/v1/ats/candidates/{candidate_id}/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "tag": {
    "name": "Excellent Fit"
  }
}'
{
  "status": "<string>",
  "data": {},
  "warnings": [
    {
      "message": "<string>"
    }
  ]
}
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 Manage tags to be enabled in your scope config.

​
Example Request Body

{
  "tag": {
    "name": "Excellent Fit"
  }
}

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 add the tag to.

Body

application/json

POST /ats/candidates/:candidate_id/tags Request body

​
tag
object
required
​
remote_fields
object

Additional fields that we will pass through to specific ATS systems.

Response

POST /ats/candidates/:candidate_id/tags 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.