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
        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
    • 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
        • 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

    Channels

    Channels are the spaces members read and post in (text, announcements, forums). Create them in Community settings > Channels. That admin UI is not the messaging HTTP API.

    Public HTTP list#

    List integration channels returns the channels the API key can see.
    If the list returns 503, retry with bounded backoff, then call Get Messages once you have a channel_id.
    Channel create, update, and delete HTTP routes live under Legacy. They are not mounted on https://api.returning.ai. Do not use them.

    Iframe channels#

    An iframe channel displays an external https:// page or iframe snippet inside the community. Setup: Iframe.
    Iframe is not send-message. The listener payload is for the embedded site. Look members up with Get User Data when you need a durable profile.

    Widgets vs APIs#

    Channel widgets are embeds. See Widgets. To post from an integration, use Monitor and respond.
    Modified at 2026-08-19 03:32:43
    Previous
    Bulk update premium currency from CSV
    Next
    Iframe
    Built with