Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
ApiKeys

Revoke an API key

Deactivates an API key so it can no longer authenticate requests. The key record is retained and remains listable.

DELETE
/v1/api-keys/{id}

Deactivates an API key so it can no longer authenticate requests. The key record is retained and remains listable.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^key_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/api-keys/string"
{  "success": true}

Delete an API key

Permanently deletes an API key record. Unlike revocation, the key row is removed rather than deactivated.

Rotate an API key

Issues a replacement with the same owner, name, and permissions, then deactivates the existing key. Returns the new key, including the plaintext secret.