Update API key
PUT
/v1/communities/{communityId}/api-keys/{apiKeyId}
What this endpoint does
data.key is still returned.INFO
_id → PUT with the full intended name, permissions, and expirePeriod → prove one allowed and one forbidden call.Quick start
Authentication and permission
Complete examples
message is Update API key success. data includes _id, communityId, name, key, permissions, expirePeriod, createdAt, updatedAt.Create API key validation error.-style enum detail as create.key values.Success and readback
200. The secret does not change. List again and match _id. A key missing leaderboard still 403s GET /v1/leaderboards after this PUT unless you add that permission.Errors and recovery
| Status | When | Recovery |
|---|---|---|
400 invalid enum | Unknown permission | Use a community permission name. |
401 | Missing or invalid token | Replace the managing key. |
Retry safety
TIP
_id. Repeating the same PUT is a metadata overwrite, not a second secret.Gotchas
_id.Next steps
Request
Path Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request PUT 'https://adss-integration.returning.ai/apis/v1/communities//api-keys/' \
--header 'Content-Type: application/json' \
--data '{
"name": "Updated Slack Integration Key",
"permissions": [
"sendMessage",
"replyMessage",
"createUser",
"manageUser",
"getUserData",
"getUserStats",
"bulkUpdateUser",
"userFields"
],
"expirePeriod": 0,
"expireDate": "2025-12-15T23:59:59.000Z"
}'Response Response Example
200 - Success
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Update API key success.",
"data": {
"_id": "675b9876fedc432109876543",
"name": "Updated Slack Integration Key",
"key": "<apiKey>",
"permissions": [
"sendMessage",
"replyMessage",
"createUser",
"manageUser",
"getUserData",
"getUserStats",
"bulkUpdateUser",
"userFields"
],
"expirePeriod": 0,
"expireDate": "2025-12-15T23:59:59.000Z",
"updatedAt": "2024-12-15T15:45:22.789Z",
"createdAt": "2024-12-15T10:30:45.123Z"
}
}Modified at 2026-08-19 13:44:00