Update API key name

PATCH https://app.speybooks.com/api/v1/api-keys/{id}

Update the display name of an API key. Scopes are immutable — to change scopes, create a new key. Revoked keys cannot be updated.

Path parameters

id integer required

API key ID.

Body parameters

name string optional

New display name for the key. Scopes are immutable; create a new key to change scopes.

max length: 100

Response

200 API key name updated.

Show response fields

id integer

updated boolean

Error codes

400 Invalid name or validation error.

404 API key not found.

409 Cannot update a revoked key.

Request PATCH /v1/api-keys/{id} curl

curl -X PATCH https://api.speybooks.com/v1/api-keys/7 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Production v2"}'

Response 200

{
  "success": true,
  "data": {
    "id": 7,
    "updated": true
  }
}