Skip to main content
PUT
Update API key

Authorizations

api-token
string
header
required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Path Parameters

id
string<uuid>
required

Body

application/json

At least one field must be provided.

name
string
Maximum string length: 100
permissions
string[]

Array of permission strings. Empty arrays are silently ignored — permissions cannot be cleared via this endpoint.

allowed_subaccounts
string[]

Subaccount UUIDs this key can act on. Empty array means all subaccounts.

allowed_ips
string[]

IP addresses or CIDR ranges allowed to use this key. Empty array means no IP restriction.

expires_at
integer | null

Unix timestamp for key expiry. Must be in the future.

is_active
boolean

Enable or disable the key without deleting it.

Response

Updated API key

success
boolean
message
string
Example:

"API key updated successfully"

data
object