Returning.AI
    • Getting Started
    • Bulk Operations
      • List bulk update jobs
        GET
      • Get bulk update job status
        GET
      • Get bulk update job details
        GET
      • Bulk update users from CSV
        POST
      • Bulk update premium currency from CSV
        POST
    • Chart Analysis
      • Create Analysis
        POST
      • Get Analysis
        GET
      • Update Analysis
        PATCH
      • Delete Analysis
        DELETE
      • List Analyses
        GET
      • Append Drawings
        POST
    • Rewards & Redemptions
      • Update redemption order status
        PUT
      • List redemption orders by user email
        POST
      • List redemption statuses
        POST
      • Get redemption status by ID
        POST
      • List redemption orders by community
        POST
      • Create redemption order status
        POST
      • Get redemption order status history
        POST
    • Gamification
      • 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
        • List user streak logs
        • Update user spin-wheel information
      • Referral
        • Get referral programs
        • Get user's referral summary
      • Rolling Data
        • Get Daily Calculation Data
        • Get Rolling Calculation Data
      • Get tiers and XP settings
        GET
      • Get daily user gamification history
        POST
      • List user gamification logs
        POST
      • Get user activity stats
        POST
    • Messaging
      • Message Actions
        • Direct Channel
          • private DM channel
            • Reply Message
            • Send Message
            • React Message
          • public channel
            • Reply Message
            • Send Message
            • React Message
        • Forum Channel
          • Send Message
          • Reply Message
          • React Message
        • Text Channel
          • Reply Message
          • Send Message
          • React Message
        • Iframe Channel
          • Reply Message
          • Send Message
          • React Message
      • Get Messages
      • Send Message
      • Reply Message
      • React Message
      • Upload message images
    • Users
      • Get user
      • Get Users with Filters
      • Create New User
      • Get User Data
      • Manage User Account
      • List mini-game logs by user email
      • Get user's current Mini Games and Streak stats
      • Get User Milestones
      • Update User Data, Identifier, And Roles
    • Authentication
      • Register user with password
      • Verify user email
      • Log in user with password
      • Secure Auth
    • 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
    • Store
      • Purchase History
        • Update purchase history 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
        • Create products in bulk
        • Create product with vouchers
        • Update products in bulk
        • Read product
        • Update product and append vouchers
        • Delete product
      • Redemption-transaction
        • Get Redemption Transaction Detail
      • Get store configuration
      • Update store configuration
    • Community Analytics
      • Get Loyalty Overview
      • Get Phone Verification Contacts
    • Community
      • 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
      • Community API Keys
        • Create API key
        • Read API keys
        • Delete API key
        • Update API key
      • 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 History
        • List Community User-Field History
        • List One Field Across Users
        • List One User Across Fields
        • List One User's One Field
        • Update A User Field Value
        • Deprecated Field-First History Write
        • Deprecated Field-First History Read
      • Create A User Field Definition
      • Get Specific User Field
      • Update Custom User Field
      • Delete Custom User Field
      • Get all user fields for a community
      • Delete user field
      • Update user field
      • Get specific user field
    • Legacy
      • Servers
        • Create server
        • List servers
        • Update server metadata
      • Bulk Operations
        • Bulk import users from CSV
      • Badges
        • List badges
        • Create badge
        • Update badge
        • Delete badge
        • Remove badge from user
        • Award badge to user
      • Messaging
        • Reply to message
        • Send message
        • React to message
      • Roles & Permissions
        • List server roles
        • Create role
        • Update role
        • Delete role
        • List user roles
        • Add role to user
        • Remove role from user
      • Users
        • 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

    Getting Started

    Almost all endpoints will require authentication to ensure secure access.

    Supported Methods#

    1.
    API Key : Used for system API endpoints. Include an X-API-Key header with the key.
    Key is found in community settings > Login Management > API key
    image.png
    Each community has only one such key, which grants full permissions for all system endpoints.
    2.
    Bearer token: Used for Application and Intergration API endpoints. Include an Authorization header with the format Bearer YOUR_TOKEN.
    Token is found in community settings > Integration > API key
    image.png
    API keys must be created by admins. Each key can have unique permissions and an expiration date.
    Individual endpoints require specific permissions, which are documented in their respective sections.
    3.
    User API key: Used for User Api endpoints.
    Include an Authorization header with the format Bearer YOUR_TOKEN.
    Token is found in user prefernces > API keys

    Error Handling#

    401: Insufficient permissions for the requested action/ Invalid token.
    Modified at 2026-04-09 03:35:17
    Next
    List bulk update jobs
    Built with