Skip to main content
DELETE
Revoke an API key

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Path Parameters

keyId
string
required

Response

The revoked API key.

API key metadata without secret material.

id
string
required
name
string
required
environment
enum<string>
required
Available options:
live,
test
scopes
enum<string>[]
required

Workspace API key permission scope.

Available options:
customers:read,
customers:write,
conversations:read,
conversations:write,
messages:write,
attachments:read,
attachments:write,
webhooks:manage,
realtime:read,
ai:use,
keys:manage,
help:read,
help:drafts:write
display
string
required
createdAt
string<date-time>
required
lastUsedAt
string<date-time> | null
revokedAt
string<date-time> | null