Skip to main content
POST
Create a new campaign

Authorizations

apikey
string
header
required

Your CometChat REST API Key.

Headers

appid
string
required

Tenant application ID

Body

application/json
name
string
required

Campaign name

templateId
string
required

Template ID (CUID or templateId slug)

templateVersion
number
required

Template version number to pin

Required range: x >= 1
variables
object

Campaign-level default variables — applied to every recipient as a fallback layer below per-user CSV values and above template variableSchema defaults. Example: { "promoCode": "SUMMER25", "supportEmail": "help@acme.io" }.

Example:
config
object

Additional campaign configuration (free-form)

Response

201

Campaign created