Create a new channel (admin only)

Create a new channel.

POST /channels

Create a new channel (admin only)

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/campaigns/channels \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'appid: <appid>' \
  --data '
{
  "name": "My Push Channel",
  "type": "push",
  "channelId": "cc-notification-channel-my-push",
  "enabled": false,
  "metadata": {
    "apiKey": "xxx",
    "senderId": "yyy"
  }
}
'

Authorizations

Authorization · string · header · required

Service-to-service basic auth

Headers

appid · string · required

Tenant application ID

Body

application/json

name · string · required

Channel display name

Example:

"My Push Channel"

type · enum<string> · required

Channel type

Available options: in_app, push, sms, email, whatsapp, custom

Example:

"push"

channelId · string

Channel slug (auto-generated from name if omitted)

Example:

"cc-notification-channel-my-push"

enabled · boolean · default: false

Whether the channel is enabled

metadata · object

Channel-specific metadata

Example:

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

Response

201

Channel created