Skip to main content

Archive Campaign

Archive a campaign. Allowed from DRAFT, PAUSED, COMPLETED, or CANCELLED status. Cannot archive campaigns that are actively queued or processing.


Endpoint

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

Path Parameters

ParameterTypeRequiredDescription
idstringrequiredThe campaign ID.

Sample Request

POST https://api.campaignlark.com/v1/campaigns/64f1a2b3c4d5e6f7a8b9c0d1/archive

Response

Success — 200 OK

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

Errors

StatusMessageCause
400Please provide a campaign ID.id path param is missing.
400The campaign cannot be archived. It may not exist, is already archived, or is currently active.Campaign is in an invalid state for archival.