Archive SMS Campaign

Archive an SMS campaign for organisational purposes. Queued campaigns must be cancelled first.

---

Endpoint

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

---

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/archive

---

Response

Success — 200 OK

{
  "error": null,
  "data": {
    "id": "64f1a2b3c4d5e6f7a8b9c0d1",
    "workspace_id": 42,
    "name": "Summer Sale SMS",
    "message": "Summer sale: 20% off today. https://example.com/sale",
    "audience": [],
    "status": "ARCHIVED",
    "statistics": {
      "sent": 0,
      "delivered": 0,
      "clicked": 0,
      "failed": 0,
      "unsubscribed": 0,
      "suppressed": 0
    },
    "created_at": "2025-06-30T12:00:00Z",
    "updated_at": "2025-07-01T09:05:00Z"
  }
}

---

Errors

Status	Message	Cause
400	Please provide a campaign ID.	id is missing.
400	We could not find the campaign you are looking for.	The ID is malformed or the campaign does not exist in the workspace.
400	Queued campaigns must be cancelled before they can be archived.	The campaign is queued.
400	The campaign is already archived.	The campaign is already archived.
400	Only draft, completed, or cancelled campaigns can be archived.	The campaign is in another status.