1. User API Keys
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
        GET
      • Create user API key
        POST
      • Update user API key
        PUT
      • Delete user API key
        DELETE
      • Get current API key information
        GET
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. User API Keys

Create user API key

POST
/v1/users/apikeys

What this endpoint does#

This page documents the user API key surface (/v1/users/apikeys, /v1/api-key-info, and the user-scoped update/delete paths). Those routes are not mounted on https://api.returning.ai.
Do not generate user-key scripts from these pages. Manage community API keys instead.
INFO
Replacement
GET/POST /v1/communities/{communityId}/api-keys and PUT/DELETE /v1/communities/{communityId}/api-keys/{apiKeyId}.

Quick start#

Do not call the user-key routes for integrations:
404 Route not found error. detail: Cannot GET /apis/v1/users/apikeys.
404.

Authentication and permission#

A valid community key does not mount these paths. Adding user-key permissions will not change that.
Intended user-key permission names (sendMessages, replyMessages, reactToMessages) are not interchangeable with community names (sendMessage, replyMessage).

Complete examples#

There is no success example on this gateway.
Update/delete pages in Apidog currently hard-code path ObjectIds. Do not copy those ids.

Success and readback#

No success response. For community keys, list by community ObjectId and match name. Create returns key once. List also returns key.

Errors and recovery#

StatusWhenRecovery
404 Cannot GET /apis/v1/users/apikeysUser key listUse community API key routes.
404/v1/api-key-infoList community keys by name.

Retry safety#

WARNING
Do not retry
Repeating these GETs will not mount the routes.

Gotchas#

Widget WIDGET_API_KEY is a different credential than these user API key routes.

Next steps#

Read community API keys
List community keys. Treat data[].key as secret-bearing.

Request

Query Params

Header Params

Body Params text/plain
Examples

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/users/apikeys?userId=71100af5c548eb5c7ebc7819' \
--header 'Authorization: Bearer <apiKey>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "testing",
    "permissions": [
        "sendMessages"
    ],
    "expirePeriod": 0,
    "expireDate": "",
    "communityId": "6167dba9c548eb5c7ec28057"
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-08-19 03:31:43
Previous
List user API keys
Next
Update user API key
Built with