---
title: "Archive a keyword"
method: POST
path: "/locations/keywords/archive"
tags: ["Rankings"]
---

# Archive a keyword

`POST /locations/keywords/archive`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/keywords/archive`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/keywords/archive/post.ts> (a function with typed inputs; its response is checked against the schema)

This API removes a keyword from the list of tracked keywords for a specific location by archiving it.

## Headers

- `Authorization` string, required

## Request body

- object
  - `id` string, required: Keyword ID to archive

## Response `200`

Successful response

- object
  - `data` object
    - `archiveKeyword` object
      - `keyword` object
        - `id` string: The unique ID attached to the keyword
        - `archived` boolean: Indicates if the keyword has been archived
        - `name` string: The text value of the keyword

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)