Returning.AI

update channel

Developing

PUT

/channels/{id}

Request

Path Params

string

required

Example:

67d04e05f090d20ae5342121

Header Params

x-api-key

string

required

Example:

39ff3ed6755b5103d4f426221a1edcfaad6f96189148d1f8871905bdb61965bb

Body Params application/json

topic

string

required

channelType

string

required

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

meta

object

required

success

boolean

required

message

string

required

devMessage

string

required

body

object

required

_id

string

required

title

string

required

permissions

array[string]

required

userId

string

required

serverId

string

required

channelType

string

required

createdAt

string

required

updatedAt

string

required

__v

integer

required

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

create new channel

delete channel