---
title: "Update API key description"
method: PUT
path: "/api/api-key/{id}"
tags: ["API Key"]
---

# Update API key description

`PUT /api/api-key/{id}`

## Path parameters

- `id` string, required

## Request body

- UpdateDescriptionInputDto
  - `description` string, required

## Response `200`

- ApiKey
  - `_id` string, required
  - `name` string, required
  - `description` string, required
  - `hash` string, required
  - `role` 'USER' | 'QUANTIFIER' | 'FORWARDER' | 'ADMIN' | 'ROOT' | 'API_KEY_READWRITE' | 'API_KEY_READ' | 'API_KEY_DISCORD_BOT' | 'API_KEY_SETUP_WEB', required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `201` — API key with updated description

## Changes

- **2023-04-27** `e14b4c818c53` — 1 info
  - endpoint added
- **2023-04-27** `e8ffc3233d9e` — 1 breaking
  - api path removed without deprecation
- **2023-04-12** `4160f5aaad3e` — 2 info
  - added the required property `_id` to the response with the `200` status
  - added the required property `_id` to the response with the `201` status
- **2023-04-04** `aa4804c758aa` — 1 info
  - endpoint added
- **2023-04-04** `9acb2632a6fd` — 1 breaking
  - api path removed without deprecation

[Full history](https://skmtc.dev/givepraise/apis/praise-api/changes/api/api-key/:id/put.md)

---

[API](https://skmtc.dev/givepraise/apis/praise-api.md) · [All operations](https://skmtc.dev/givepraise/apis/praise-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/givepraise/praise-api/revisions/038d95bf55fd/schema)