Candidate Tags

An association between a candidate and a corresponding tag for which the candidate has

Create a candidate tag

POST https://endorsed.ai/api/v1/candidate_tags

Creates a new candidate tag and returns the candidate tag's UUID id. Tags are also unique by the following fields (candidate_id, tag_id, and creation_method) as these fields serve as a composite key in addition to the unique id field.

Headers

Request Body

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92ac-d0a83c2816fa"
  }
}

Examples:

curl -X POST "${BASE_URL}/api/v1/candidate_tags" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{
  "candidate_id": "172a09e0-9983-44df-a5ae-cd7cc2624cbd",
  "tag_id": "6b7061fd-634f-4b89-bb90-9cc182cd0c6d",
  "creation_method": "custom_input_by_candidate"
}'

Get an existing candidate tag

GET https://endorsed.ai/api/v1/candidate_tags/{id}

Get an existing candidate tag by it's UUID id.

Path Parameters

Headers

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92ac-d0a83c2816fa",
    "candidate_id": "172a09e0-9983-44df-a5ae-cd7cc2624cbd",
    "tag_id": "6b7061fd-634f-4b89-bb90-9cc182cd0c6d",
    "creation_method": "custom_input_by_candidate",
    "created_at": "2023-09-25T22:06:01.000Z"
  }
}

Examples:

curl -X GET "${BASE_URL}/api/v1/candidate_tags/b49fe98f-859d-4da1-92ac-d0a83c2816fa" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

Delete an existing candidate tag

DELETE https://endorsed.ai/api/v1/candidate_tags/{id}

Deletes an existing candidate tag by it's UUID id.

Path Parameters

Headers

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92AC-d0a83c2816fa"
  }
}

Examples:

curl -X DELETE "${BASE_URL}/api/v1/candidate_tags/b49fe98f-859d-4da1-92ac-d0a83c2816fa" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

Last updated

© 2024 Endorsed