1. Community 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
        POST
      • Read API keys
        GET
      • Delete API key
        DELETE
      • Update API key
        PUT
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • 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. Community API Keys

Create API key

POST
/v1/communities/{communityId}/api-keys

What this endpoint does#

Creates a community API key for one community ObjectId. The create body returns the raw key once in the same envelope later list/update/delete also return. Treat every management response as secret-bearing.
It does not create user API keys. Those routes are not mounted on this gateway.
INFO
Workflow
List keys by name → POST a least-privilege key → store data.key in server-side secret storage → prove one allowed call → delete when rotating.

Quick start#

expirePeriod: 0 means no expiry. Replace <communityId> with the 24-character community ObjectId.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. The managing key must belong to that community. Keep it server-side.

Complete examples#

Created (201). message is Create API key success. Envelope { meta: { status: "success", statusCode: 201 }, message, data }.
data includes _id, name, key, permissions, expirePeriod, createdAt, updatedAt.
Missing name (400). Create API key validation error. detail.name: API key name is required.
Invalid permission (400). detail.permissions lists the allowed enum. Community names include getUserData, sendMessage, leaderboard, appearance, getBulkUpdate. User-key names such as sendMessages are not valid here.
Never paste live key values into docs, tickets, or examples.

Success and readback#

HTTP 201. Store data.key immediately. Read back with list and match _id or name. Update keeps the same key. Delete revokes it.
CHECK
Secret-bearing create
If data.key is present, redact it in logs. Listing the same key later also returns key.

Errors and recovery#

StatusWhenRecovery
400 name requiredMissing nameSend a unique name.
400 invalid enumUnknown permission stringUse a community permission from the error detail.
400 duplicate namename already existsPick a new name or update the existing key.
401Missing or invalid tokenAdd a valid community key.

Retry safety#

WARNING
Exact retry
A timeout can hide a successful create. List by name before posting the same body again. Duplicate names conflict; a second successful create with a new name is another secret.

Gotchas#

List/update/delete also return key. The OpenAPI text that says list keys are masked is wrong on https://api.returning.ai.
GET /v1/users/apikeys and GET /v1/api-key-info 404.
Widget embed keys are a different credential.

Next steps#

Read community API keys
Confirm the new _id and permissions. Treat data[].key as secret-bearing.

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created
application/json
Create API key successful
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409Server Error
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://adss-integration.returning.ai/apis/v1/communities//api-keys' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Slack Integration API Key",
    "permissions": [
        "sendMessage",
        "replyMessage",
        "createUser",
        "manageUser",
        "getUserData",
        "getUserStats",
        "bulkUpdateUser",
        "userFields"
    ],
    "expirePeriod": 0
}'
Response Response Example
201 - Success
{
    "meta": {
        "status": "success",
        "statusCode": 201
    },
    "message": "Create API key success.",
    "data": {
        "_id": "675b9876fedc432109876543",
        "name": "Slack Integration API Key",
        "key": "<apiKey>",
        "permissions": [
            "sendMessage",
            "replyMessage",
            "createUser",
            "manageUser",
            "getUserData",
            "getUserStats",
            "bulkUpdateUser",
            "userFields"
        ],
        "expirePeriod": 0,
        "expireDate": "",
        "updatedAt": "2024-12-15T10:30:45.123Z",
        "createdAt": "2024-12-15T10:30:45.123Z"
    }
}
Modified at 2026-08-19 13:43:51
Previous
API key lifecycle
Next
Read API keys
Built with