Skip to main content
POST
Create a new channel

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:

Response

Channel created