Cancel SMS Campaign

Cancel a queued SMS campaign. Recipients whose messages never reached a provider are refundable; recipients already handed to a carrier remain charged.

---

Endpoint

POST https://api.campaignlark.com/v1/sms-campaigns/:id/cancel

---

Path Parameters

Parameter	Type	Required	Description
id	string	required	Campaign ID as a MongoDB ObjectID hex string.

---

Sample Request

POST https://api.campaignlark.com/v1/sms-campaigns/64f1a2b3c4d5e6f7a8b9c0d1/cancel

---

Response

Success — 200 OK

{
  "error": null,
  "data": {
    "id": "64f1a2b3c4d5e6f7a8b9c0d1",
    "status": "CANCELLED"
  }
}

---

Errors

Status	Message	Cause
400	Please provide a campaign ID.	id is missing.
400	Only queued campaigns can be cancelled.	The campaign is not in a cancellable state.