---
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
  - `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-03-31** `af4ea0086c6f` — 2 breaking
  - removed the required property `_id` from the response with the `200` status
  - removed the required property `_id` from the response with the `201` status

[Change 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/af4ea0086c6f/schema)