Get a WhatsApp campaign

gethttps://api.chat-data.com/api/v2/whatsapp-campaigns/{campaignId}/whatsapp-campaigns/{campaignId}

Any keyWorkspace or chatbot key

Returns one campaign with its counters and exclusions.

Parameters

Sending 2 of 2 fields

Required

campaignIdstring

chatbotIdstring

Try it · GET /whatsapp-campaigns/{campaignId}

curl 'https://api.chat-data.com/api/v2/whatsapp-campaigns/6650f1c2a9e4b83d2c7a1f3c?chatbotId=6650f1c2a9e4b83d2c7a1f05' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY"

Loading…

{  "status": "success",  "campaign": {    "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"  }}

Responses

The campaign.

Content type: application/json

Field	Type	Description
statusstring	string	One of: `success`.
campaignobject	object
campaign.idstring	string
campaign.namestring	string
campaign.phoneNumberIdstring	string
campaign.templateobject	object
campaign.template.namestring	string
campaign.template.languagestring	string
campaign.template.categorystring	string
campaign.replyModestring	string	One of: `ai`, `live_chat`.
campaign.statusstring	string	One of: `draft`, `scheduled`, `sending`, `paused`, `completed`, `cancelled`, `failed`.
campaign.pauseReasonstring	string
campaign.scheduleobject	object
campaign.schedule.atstring	string
campaign.schedule.timeZonestring	string
campaign.recipientsinteger	integer	Recipients after exclusions, set when the campaign starts.
campaign.exclusionsobject	object	Excluded numbers by reason.
campaign.statsobject	object	`sent`, `delivered`, `read` and `replied` count every message that reached that stage (a read message was also delivered).
campaign.stats.queuedinteger	integer
campaign.stats.sentinteger	integer
campaign.stats.deliveredinteger	integer
campaign.stats.readinteger	integer
campaign.stats.repliedinteger	integer
campaign.stats.formCompletedinteger	integer
campaign.stats.failedinteger	integer
campaign.stats.cancelledinteger	integer
campaign.startedAtstring	string
campaign.completedAtstring	string
campaign.createdAtstring	string

Example

{  "status": "success",  "campaign": {    "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"  }}

Last updated October 14, 2026