Update user API key
PUT
/v1/users/71100af5c548eb5c7ebc7819/api-keys/689b34c3799e47c88fa2f89d
How to use it: Send a PUT request to
/v1/users/71100af5c548eb5c7ebc7819/api-keys/689b34c3799e47c88fa2f89d with the request body, query parameters, or multipart fields shown below. Authorization: Bearer <apiKey>. The key must be active, unexpired, scoped to the correct community, and include the permission required by this endpoint.Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under
data with status and message.Common error states:
400 invalid request body, query, ObjectId, pagination, file format, or missing required field.401 missing, invalid, expired, or insufficient API key/token.403 key is valid but cannot access this community/channel/user/resource, where supported by the service.404 target resource, route, or community-scoped record was not found.409 duplicate or conflicting state for create/update operations, where applicable.500 unexpected Returning.AI service error.Request
Body Params text/plain
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.returning.ai/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-05-18 17:03:37