Skip to main content
POST
Create a new template

Authorizations

apikey
string
header
required

Your CometChat REST API Key.

Headers

appid
string
required

Tenant application ID

Body

application/json
name
string
required

Template name

channels
object[]
required

Channel configurations

templateId
string

Human-readable slug (auto-generated from name if omitted)

templateCategory
enum<string>

Template category

Available options:
Onboarding,
Transactional,
Marketing,
Product_Showcase,
Alerts,
Polls,
Custom
label
string

Display label shown on notification (e.g. Promo, Alert)

alternativeText
string

Plain-text fallback when push is suppressed or rich content cannot render. Sendbird-parity field.

tags
string[]

First-class tags for filtering/segmentation

status
enum<string>

Template status

Available options:
draft,
approved,
archived
variableSchema
object[]

Variable schema definitions

config
object

Additional configuration

Response

Template created