Skip to content

Cancel a WhatsApp campaign

post/whatsapp-campaigns/{campaignId}/cancel
Any key

Cancels a scheduled, sending or paused campaign. Recipients not yet sent are marked cancelled; messages already sent are not recalled.

Path parameters

Required
campaignIdstring

Request body

Sending 1 of 1 field
Required
chatbotIdstring

Only these fields are sent (application/json).

Try it · POST /whatsapp-campaigns/{campaignId}/cancel
curl 'https://api.chat-data.com/api/v2/whatsapp-campaigns/6650f1c2a9e4b83d2c7a1f3c/cancel' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "chatbotId": "6650f1c2a9e4b83d2c7a1f05"}'
Loading…

Responses

The cancelled campaign.

Content type: application/json

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

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