Skip to content

List WhatsApp campaigns

get/whatsapp-campaigns
Any key

Lists the chatbot's campaigns, newest first, 20 per page, with their counters.

Parameters

Sending 1 of 4 fields
Required
chatbotIdstring
Try it · GET /whatsapp-campaigns
curl 'https://api.chat-data.com/api/v2/whatsapp-campaigns?chatbotId=6650f1c2a9e4b83d2c7a1f05' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY"
Loading…

Responses

A page of campaigns.

Content type: application/json

FieldDescription
statusstringOne of: success.
campaignsarray of object
campaigns[].idstring
campaigns[].namestring
campaigns[].phoneNumberIdstring
campaigns[].templateobject
campaigns[].template.namestring
campaigns[].template.languagestring
campaigns[].template.categorystring
campaigns[].replyModestringOne of: ai, live_chat.
campaigns[].statusstringOne of: draft, scheduled, sending, paused, completed, cancelled, failed.
campaigns[].pauseReasonstring
campaigns[].scheduleobject
campaigns[].schedule.atstring
campaigns[].schedule.timeZonestring
campaigns[].recipientsintegerRecipients after exclusions, set when the campaign starts.
campaigns[].exclusionsobjectExcluded numbers by reason.
campaigns[].statsobjectsent, delivered, read and replied count every message that reached that stage (a read message was also delivered).
campaigns[].stats.queuedinteger
campaigns[].stats.sentinteger
campaigns[].stats.deliveredinteger
campaigns[].stats.readinteger
campaigns[].stats.repliedinteger
campaigns[].stats.formCompletedinteger
campaigns[].stats.failedinteger
campaigns[].stats.cancelledinteger
campaigns[].startedAtstring
campaigns[].completedAtstring
campaigns[].createdAtstring
totalinteger
pageinteger
pageSizeinteger

Example

{  "status": "success",  "campaigns": [    {      "id": "6650f1c2a9e4b83d2c7a1f3c",      "name": "Jane Doe",      "phoneNumberId": "6650f1c2a9e4b83d2c7a1f3c",      "template": {        "name": "Jane Doe",        "language": "sample language",        "category": "sample category"      },      "replyMode": "ai",      "status": "draft",      "pauseReason": "sample pause reason",      "schedule": {        "at": "2026-10-14T09:30:00.000Z",        "timeZone": "sample time zone"      },      "recipients": 10,      "exclusions": {        "opted_out": 3,        "us_marketing": 12      },      "stats": {        "queued": 10,        "sent": 10,        "delivered": 10,        "read": 10,        "replied": 10,        "formCompleted": 10,        "failed": 10,        "cancelled": 10      },      "startedAt": "2026-10-14T09:30:00.000Z",      "completedAt": "2026-10-14T09:30:00.000Z",      "createdAt": "2026-10-14T09:30:00.000Z"    }  ],  "total": 10,  "page": 10,  "pageSize": 10}

Last updated October 14, 2026