Skip to main content
PUT
/
channels
/
{id}
Update a channel
curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/campaigns/channels/{id} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'appid: <appid>' \
  --data '
{
  "name": "<string>",
  "enabled": true,
  "metadata": {
    "apiKey": "xxx",
    "senderId": "yyy"
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

apikey
string
header
required

Your CometChat REST API Key.

Headers

appid
string
required

Tenant application ID

Path Parameters

id
string
required

Body

application/json
name
string

Channel display name

enabled
boolean

Whether the channel is enabled

metadata
object

Channel-specific metadata

Example:
{ "apiKey": "xxx", "senderId": "yyy" }

Response

Channel updated