Skip to main content
DELETE
/
v2
/
schedules
/
{id}
{
  "success": true,
  "archived": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.tracklysms.com/llms.txt

Use this file to discover all available pages before exploring further.

Soft-delete a schedule by setting its status to archive. Archived schedules are excluded from the default List Schedules response but can still be retrieved by explicitly filtering with status=archive. This operation is not reversible through the API. To restore an archived schedule, use the Update Schedule endpoint to change its status back to draft or off.

​
Path Parameters

​
id
string
required
The unique identifier of the schedule to archive.

​
Response Fields

​
success
boolean
true if the schedule was archived successfully.
​
archived
boolean
true confirming the schedule has been moved to archive status.

​
Examples

cURL
curl -X DELETE "https://api.tracklysms.com/api/v2/schedules/6651a3f2e4b0a1c2d3e4f567" \
  -H "X-Api-Key: trk_your_api_key_here"
Python
import requests

schedule_id = "6651a3f2e4b0a1c2d3e4f567"

response = requests.delete(
    f"https://api.tracklysms.com/api/v2/schedules/{schedule_id}",
    headers={"X-Api-Key": "trk_your_api_key_here"},
)

data = response.json()
if data["success"]:
    print("Schedule archived successfully.")
Node.js
const scheduleId = "6651a3f2e4b0a1c2d3e4f567";

const response = await fetch(
  `https://api.tracklysms.com/api/v2/schedules/${scheduleId}`,
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "trk_your_api_key_here"
    }
  }
);

const data = await response.json();
if (data.success) {
  console.log("Schedule archived successfully.");
}

{
  "success": true,
  "archived": true
}

​
Error Codes

HTTP StatusError CodeDescription
401unauthorizedAPI key is missing, invalid, or revoked.
404not_foundNo schedule exists with the given ID.

​
Next Steps

Campaign Scheduling

Learn about scheduling

List Audiences

View audiences