Campaigns
Send bulk messages to a list of contacts.
Campaigns let you send a template message to hundreds or thousands of contacts at once. Each recipient can have its own template variable values, or you can set defaults. You can pause, resume, and cancel running campaigns.
Each recipient can have its own template variable values.
Copy this section as context for your AI coding agent
curl -X POST 'https://api.chatverse.io/v1/whatsapp/campaigns' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Order updates",
"template": "order_update",
"recipients": [
"919876543210",
{
"to": "919812345678",
"body": [
"Ravi",
"ORD-2"
]
}
],
"defaults": {
"body": [
"Customer",
"ORD-1"
]
},
"send_now": true
}'Response · 201
json
{
"success": true,
"data": {
"campaign": {
"id": "5b1e0c52-9d3a-4c1e-8f60-2d7a1b9c3e44",
"name": "Order updates",
"status": "QUEUED",
"total_recipients": 120,
"queued_count": 118,
"skipped_count": 2
},
"queued": 118,
"skipped": 2
}
}Up to 5,000 recipients. With send_now: false the campaign is saved as a DRAFT (no queued/skipped yet); start it later with POST /v1/whatsapp/campaigns/{id}/send.
curl -X GET 'https://api.chatverse.io/v1/whatsapp/campaigns' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"data": {
"campaigns": [
{
"id": "5b1e0c52-…",
"name": "Order updates",
"status": "SENDING",
"sent_count": 64,
"delivered_count": 60
}
],
"total": 37,
"limit": 20,
"offset": 0
}
}curl -X GET 'https://api.chatverse.io/v1/whatsapp/campaigns/{id}' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"data": {
"id": "5b1e0c52-…",
"status": "SENDING",
"queued_count": 54,
"sent_count": 64,
"delivered_count": 60,
"read_count": 31
}
}curl -X POST 'https://api.chatverse.io/v1/whatsapp/campaigns/{id}/send' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"message": "Campaign queued: 118 recipient(s), 2 skipped. Sending in the background - poll status for progress.",
"data": {
"campaign_id": "5b1e0c52-…",
"status": "QUEUED",
"queued": 118,
"skipped": 2
}
}curl -X POST 'https://api.chatverse.io/v1/whatsapp/campaigns/{id}/pause' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"message": "Campaign paused",
"data": {
"status": "PAUSED"
}
}curl -X POST 'https://api.chatverse.io/v1/whatsapp/campaigns/{id}/resume' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"message": "Campaign resumed",
"data": {
"status": "SENDING"
}
}curl -X POST 'https://api.chatverse.io/v1/whatsapp/campaigns/{id}/cancel' \
-H 'Authorization: Bearer YOUR_API_KEY'Response · 200
json
{
"success": true,
"message": "Campaign cancelled",
"data": {
"status": "CANCELLED"
}
}