Skip to main content
POST
/
channels
Create a new channel
curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/campaigns/channels \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'appid: <appid>' \
  --data '
{
  "name": "My Push Channel",
  "type": "push",
  "channelId": "cc-notification-channel-my-push",
  "enabled": false,
  "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

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

Channel created