---
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
  - `creator_display_label` string, nullable — Name of the member who created the key, falling back to their display handle when no name is set. Null on keys created before creators were recorded, and on workspace types whose keys are shared rather than owned by one member.

## Other responses

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

## Changes

- **2026-08-31** `583d86789548` — 1 info
  - added the optional property `creator_display_label` to the response with the `200` status

[Change history](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/changes/manage/api/api_keys/:api_key_id/patch.md)

---

[API](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ideogram/ideogram-openapi-3-0/revisions/583d86789548/schema)