Skip to main content
POST
/
ats
/
candidates
/
{candidate_id}
/
tags
Python
from kombo import SDK


with SDK(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.ats.add_candidate_tag(candidate_id="8Xi6iZrwusZqJmDGXs49GBmJ", tag={
        "name": "Excellent Fit",
    })

    # Handle response
    print(res)
{
"status": "success",
"data": {},
"warnings": [
{
"message": "This is an example warning!"
}
]
}

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
Examples:
{}
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.