Skip to main content
PATCH
Rename Key

Authorizations

X-API-Key
string
header
required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

authorization
string | null
X-API-Key
string | null
POLY_API_KEY
string | null
Poly-API-Key
string | null

Path Parameters

key_id
integer
required

Body

application/json

Partial update: only the fields present in the body change.

default_magic
integer | null

Magic number (0..9223372036854775807) stamped on every order placed with this key that does not send its own magic. Give each bot its own key to tag its orders without code changes.

Required range: 0 <= x <= 9223372036854776000
default_magic_label
string | null

Bot label (max 32 printable characters) stamped on every order placed with this key that does not send its own magic_label.

Maximum string length: 32
name
string | null

New human-readable label (null clears it)

Maximum string length: 100

Response

Successful Response

id
integer
required
key_prefix
string
required
rate_limit_tier
string
required
is_active
boolean
required
name
string | null
permissions
string[] | null
created_at
string | null
last_used_at
string | null
expires_at
string | null
default_magic
integer | null

Magic number (0..9223372036854775807) stamped on every order placed with this key that does not send its own magic. Give each bot its own key to tag its orders without code changes.

default_magic_label
string | null

Bot label (max 32 printable characters) stamped on every order placed with this key that does not send its own magic_label.