Rename an API key

PATCH/v1/admin/api-keys/{id}Admin key

Only the name can change. Mode, expiry and the key value are fixed; to change those, create a new key and revoke the old one.

Path parameters

idstringpathrequired

The key ID, for example key_01K6B1T8W2N5R7X9Q3M6V4ZP8H.

Body parameters

namestringrequired

The new label, 1 to 200 characters.

Response

Status 200 with the key record (no full key), as described in Create an API key.

Errors

Status	Code	When
400	`invalid_body`	`name` is missing, empty or longer than 200 characters.
404	`api_key_not_found`	No key has this ID.

Request

const res = await fetch(
  'https://mailer.example.com/v1/admin/api-keys/key_01K6B1T8W2N5R7X9Q3M6V4ZP8H',
  {
    method: 'PATCH',
    headers: {
      Authorization: `Bearer ${process.env.FLARESEND_ADMIN_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ name: 'production-api' }),
  },
);
const key = await res.json();

Response

{
  "id": "key_01K6B1T8W2N5R7X9Q3M6V4ZP8H",
  "projectId": "proj_01K6B1QZ3M8H2V5T7R9N4XW6CD",
  "name": "production-api",
  "mode": "live",
  "prefix": "fs_live_7Hq2",
  "lastUsedAt": "2026-09-26T14:02:11.000Z",
  "createdAt": "2026-09-26T10:05:00.000Z",
  "revokedAt": null,
  "expiresAt": null
}

Path parametersCopy Anchor Link

Body parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Body parameters

Response

Errors