Delete API key
DELETE
/v1/communities/{communityId}/api-keys/{apiKeyId}
What this endpoint does
data.key. Treat it as secret-bearing.INFO
DELETE the old _id → list and confirm the _id is gone.Quick start
Authentication and permission
Complete examples
message is Delete API key success. Envelope includes data._id, name, key, and permissions of the revoked key.Success and readback
200. List community keys and confirm the _id is absent. Calls with the revoked secret should fail authentication.Errors and recovery
| Status | When | Recovery |
|---|---|---|
401 | Missing or invalid token | Use a managing key that still exists. |
Retry safety
WARNING
_id before deleting again. Do not retry blindly against a key you still need.Gotchas
Next steps
Request
Path Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://adss-integration.returning.ai/apis/v1/communities//api-keys/'Response Response Example
200 - Production API key deleted
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Delete API key success.",
"data": {
"_id": "675b9876fedc432109876543",
"name": "Slack Integration API Key",
"key": "<apiKey>",
"permissions": [
"sendMessage",
"replyMessage",
"createUser",
"manageUser",
"getUserData",
"getUserStats",
"bulkUpdateUser",
"userFields"
],
"expirePeriod": 365,
"expireDate": "2025-12-15T23:59:59.000Z",
"updatedAt": "2024-12-15T10:30:45.123Z",
"createdAt": "2024-01-15T09:15:22.456Z"
}
}Modified at 2026-08-19 13:44:09