Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-campaigns-service-rest-api.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A user in Campaigns is the same as a CometChat user — identified by their uid. The Users page in the dashboard lets you browse users registered in your CometChat app. No separate user creation is needed for Campaigns.

Targeting Users

When creating a campaign, you can target users through the following methods:
MethodDescription
CSV uploadUpload a CSV file with a user_id column and optional per-user variables
User pickerSelect from the Users list in the dashboard

Filtering Users

The Users page supports filtering by:
FilterDescription
SearchFilter by UID or name
RoleFilter by CometChat user role
StatusFilter by online / offline status
Created AtFilter by user creation date

User Preferences

User-level notification preferences (opt-in/opt-out) are not currently supported. All users in the recipient list receive the notification.

Sending Notifications to Users

You don’t always need to create a campaign to reach your users. You can send notifications directly — either from the dashboard for a single user, or via API for multiple users.

From the Dashboard

On the User Detail page, there’s a Send Notification button that lets you send a notification to that specific user. Pick a template, fill in variables, and send.

From Your Backend (API)

For sending to multiple users without a campaign, use the API. The flow is:
  1. Have at least one channel and one approved template ready.
  2. Call POST /notifications/messages from your server with the template and list of user UIDs.
  3. Optionally include per-user variables for personalization (like name, order number, etc.).
  4. Get a response confirming the send.

Delivery Modes

≤ 10 recipients> 10 recipients
ModeRealtimeBatch
DeliveryImmediate — notifications are created before the response returnsQueued — processed in the background
ResponsenotificationId + channelsbatchId + total count
ConfirmationResponse = delivery doneResponse = job queued, track via webhooks

Tracking Delivery

  • Realtime (≤ 10): A successful response means all notifications were delivered.
  • Batch (> 10): The response confirms the job is queued.
There is no dashboard view for direct notification status. Only campaigns have a detail page with delivery tracking.
For the API reference, see Send Notification.

Limits

LimitValue
Max recipients per campaign10,000
Users list page sizeConfigurable (default 20, max 100)