---
title: "Update an API key's user-supplied label."
method: PATCH
path: "/manage/api/api_keys/{api_key_id}"
tags: ["manage"]
---

# Update an API key's user-supplied label.

`PATCH /manage/api/api_keys/{api_key_id}`

## Path parameters

- `api_key_id` string, required

## Request body

- PatchApiKeyRequest
  - `label` string, nullable — New label for the API key. Pass null (or omit) to clear the existing label.

## Response `200`

The updated API key.

- ApiProfileApiKey
  - `api_key_id` string, required — Base64 encoded API key ID
  - `redacted_api_key` string, required — A redacted text snippet of the API key. Contains the first 4 characters of the API key
  - `creation_time` string, date-time, required — The date at which the API key was created
  - `status` 'ACTIVE' | 'DISABLED', required — Status of the API key
  - `label` string, nullable — An optional user-supplied label for managing the API key

## Other responses

- `400` — Invalid request.
- `401` — Not authorized.
- `404` — API key not found.

---

[API](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideogram/ideogram-openapi-3-0/versions/bcc2d45be91e/schema)