Skip to main content
POST
Add recipients manually (user IDs)

Authorizations

apikey
string
header
required

Your CometChat REST API Key.

Headers

appid
string
required

Tenant application ID

Path Parameters

id
string
required

Body

application/json
userIds
string[]
required

Array of user IDs to add as recipients

Required array length: 1 - 10000 elements
userVariables
object

Per-user variables, keyed by userId. Persisted on each CampaignRecipient.variables row at insert time. Renderer substitutes these into template content per recipient. Example: { "user_42": { "name": "Ajay" }, "user_43": { "name": "Sam" } }.

Example:

Response

Recipients added