Skip to main content
PUT
Update API Key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id
string
default:""
required

The Partner ID header used for authorization

idempotency-key
string
default:""
required

The Idempotency Key - usually a UUID

Path Parameters

secret_key
string
required

The API secret key

Example:

"36BFB7C90C7A1D3D4E09E2E2C05DDD3E"

Body

application/json

Request to update an existing API key

description
string

Description of the API key

Example:

"Api key for developers"

enabled
boolean

Whether the API key is enabled

Example:

true

name
string

Name of the API key

Example:

"Developer Api Key"

access
object

Access rights configuration

Response

Response containing API key information

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

API key information