Skip to main content
PATCH
Rename or toggle an API key

Authorizations

Authorization
string
header
required

Staff panel JWT access token

Path Parameters

id
string<uuid>
required

API key UUID

Body

application/json
name
string
Maximum string length: 100
Example:

"Renamed key"

isActive
boolean
Example:

false

Response

Updated API key

id
string<uuid>
name
string
Example:

"My CRM Integration"

type
enum<string>
Available options:
branch,
personal,
public
keyPrefix
string

First 20 chars of the key, for display

Example:

"sk_personal_Ab3x"

isActive
boolean
Example:

true

lastUsedAt
string<date-time> | null
expiresAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>