Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate Tag

candidateTag.archive

Archives a candidate tag.

Requires the hiringProcessMetadataWrite permission.

post/candidateTag.archive

Request body

tagIdstring uuid required

The candidate tag's unique id

Example request

{
  "tagId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the candidateTag.archive endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "title": "Strong candidate",
    "isArchived": true
  }
}