---
title: "Update translation key description"
method: PATCH
path: "/api/v1/translation-keys/description"
tags: ["Translation keys"]
---

# Update translation key description

`PATCH /api/v1/translation-keys/description`

## Request

- Base URL: `https://api.simplelocalize.io`
- URL: `https://api.simplelocalize.io/api/v1/translation-keys/description`
- Auth: API key in header `X-SimpleLocalize-Token`
- TypeScript: <https://skmtc.dev/simplelocalize/apis/simplelocalize-api/docs/api/v1/translation-keys/description/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates the description of a translation key, the one visible and editable in the editor. It throws an error if translation key does not exist.

Use query `key` and `namespace` parameters to identify the translation key.

Empty or null `description` clears it. Max size of description is 500 characters, otherwise, the endpoint throws an error.

## Query parameters

- `key` string, required
- `namespace` string

## Request body

- UpdateTranslationKeyDescriptionRequestV2
  - `description` string

## Response `200`

OK

## Other responses

- `400`: Bad Request
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-07** `67a25a25863a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/changes/api/v1/translation-keys/description/patch.md)

---

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