Tag a candidate
Add a tag to a candidate, creating the tag if it does not exist.
POST https://cotlet.dev/api/v1/homerun/jobs/{job_id}/candidates/{candidate_id}/tag
write
Adds the tag to the profile below the contact information. A new name creates a new tag for the whole company, so check list_tags first. Tags are internal and removed with one call of remove_candidate_tag, so it does not wait for your OK.
Parameters
| Name | Type | Description |
|---|---|---|
| job_id string required | string | Job ID from list_jobs. |
| candidate_id string required | string | Candidate ID from list_candidates. |
| tag string required | string | Tag name, preferably one from list_tags. |
Request
curl -X POST https://cotlet.dev/api/v1/homerun/jobs/job_8c41d2/candidates/candidate_8c41d2/tag \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"tag":"tag"}'result = client.call("homerun", "add_candidate_tag", {"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2","tag":"tag"})const result = await cotlet.call('homerun', 'add_candidate_tag', {"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2","tag":"tag"});cotlet call homerun add_candidate_tag --data '{"job_id":"job_8c41d2","candidate_id":"candidate_8c41d2","tag":"tag"}'Example response
{
"candidate_id": "ap_K2mP7rS1uW5yA9bC3dE6",
"status": "tagged",
"tags": [
"shortlist"
]
}