Returning.AI
  1. Channel
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • role list of server
          • channel list of server
        • Channel
          • get channels list
            GET
          • create new channel
            POST
          • update channel
            PUT
          • delete channel
            DELETE
        • Role
          • create new role
          • update role
          • delete role
          • add role to a user on a server
          • remove role from a user on a server
          • get role list of user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get specific user field
          • Create Custom User Field
          • Update user field
          • Delete user field
        • User Field Histories
          • 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
          • Create user field history for specific user
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
      • User API
        • API key
          • api key info
          • Get User Api Key
          • Post User Api Key
          • Update User Api Key
          • Delete Endpoint
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • Channels
      • Iframe
    • 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
      • Channels
      • Leaderboard
      • Milestone
      • Socials
      • Store
  1. Channel

update channel

Developing
PUT
/channels/{id}

Request

Path Params

Header Params

Body Params application/json

Example
{
    "topic": "Chit Chat",
    "channelType": "forum"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://rai-api.returning.ai/api/v1/channels/67d04e05f090d20ae5342121' \
--header 'x-api-key: 39ff3ed6755b5103d4f426221a1edcfaad6f96189148d1f8871905bdb61965bb' \
--header 'Content-Type: application/json' \
--data-raw '{
    "topic": "Chit Chat",
    "channelType": "forum"
}'

Responses

🟢200Success
application/json
Body

Example
{
    "meta": {
        "success": true,
        "message": "Channel has been updated successfully",
        "devMessage": "Channel has been updated successfully"
    },
    "body": {
        "_id": "{_id}",
        "topic": "Report",
        "permissions": [],
        "userId": "1",
        "serverId": "{_id}",
        "channelType": "open",
        "createdAt": "2024-07-25T16:50:17.610Z",
        "updatedAt": "2024-07-25T16:53:27.739Z",
        "__v": 0
    }
}
Modified at 2025-05-27 04:38:21
Previous
create new channel
Next
delete channel