---
title: "candidateTag.archive"
method: POST
path: "/candidateTag.archive"
tags: ["Candidate Tag"]
---

# candidateTag.archive

`POST /candidateTag.archive`

Archives a candidate tag.

**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagarchive) permission.**

## Request body

- CandidateTagArchiveRequest
  - `tagId` string, uuid, required — The candidate tag's unique id

## Response `200`

Responses from the candidateTag.archive endpoint

- union
  - CandidateTagArchiveSuccessResponse
    - `success` true, required
    - `results` CandidateTag, required
      - `id` string, uuid, required — The candidate tag's unique identifier
      - `title` string, required — The tag's title
      - `isArchived` boolean, required — Whether the tag has been archived
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)