Update user API key
PUT
/v1/users/71100af5c548eb5c7ebc7819/api-keys/689b34c3799e47c88fa2f89d
What this endpoint does
/v1/users/apikeys, /v1/api-key-info, and the user-scoped update/delete paths). Those routes are not mounted on https://api.returning.ai.INFO
GET/POST /v1/communities/{communityId}/api-keys and PUT/DELETE /v1/communities/{communityId}/api-keys/{apiKeyId}.Quick start
404 Route not found error. detail: Cannot GET /apis/v1/users/apikeys.404.Authentication and permission
sendMessages, replyMessages, reactToMessages) are not interchangeable with community names (sendMessage, replyMessage).Complete examples
Success and readback
name. Create returns key once. List also returns key.Errors and recovery
| Status | When | Recovery |
|---|---|---|
404 Cannot GET /apis/v1/users/apikeys | User key list | Use community API key routes. |
404 | /v1/api-key-info | List community keys by name. |
Retry safety
WARNING
Gotchas
WIDGET_API_KEY is a different credential than these user API key routes.Next steps
Request
Body Params text/plain
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://adss-integration.returning.ai/apis/v1/users/71100af5c548eb5c7ebc7819/api-keys/689b34c3799e47c88fa2f89d' \
--header 'Content-Type: text/plain' \
--data '{
"name": "Updated API Key Name",
"permissions": [
"readOwnProfile",
"updateOwnProfile",
"readOwnMessages"
],
"expirePeriod": 180,
"expireDate": "2025-06-30T23:59:59Z",
"isActive": true
}'Response Response Example
200 - Example 1
{}Modified at 2026-08-19 03:31:54