Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

The key with its new secret

object
string
required
id
string
required
name
string | null
required
last4
string
required
token_type
string
required
kind
enum<string>
required

personal acts as the person who made it; team sees only what the whole account sees.

Available options:
personal,
team
scopes
string[] | null
required

What the key may call. Null for a key made before scopes existed, which reaches everything.

token
string | null
required
last_used_at
string | null
required
expires_at
string | null
required
created_at
string
required