{
"schedules": [
{
"id": "6651a3f2e4b0a1c2d3e4f567",
"name": "Weekend Promo Blast",
"status": "on",
"send_type": "blast",
"source_lists": [101, 204],
"audiences": ["665fa1b2c3d4e5f6a7b8c901"],
"is_repeating": true,
"send_time": "14:30",
"send_date": null,
"start_date": "2025-06-01T00:00:00",
"end_date": "2025-08-31T00:00:00",
"days_of_week": {
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": true,
"saturday": true,
"sunday": true
},
"skip_within_hours": 24,
"use_local_time": true,
"filter_bots": true,
"is_transactional": false,
"is_mms": false,
"is_cto": false,
"automated_percent": 0,
"ir_revenue": 2.50,
"blasts": [
{
"message": "Flash sale this weekend! Shop now: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 60,
"variant_name": "Control",
"mms_image_url": null
},
{
"message": "Don't miss out — 20% off everything: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 40,
"variant_name": "Urgency Variant",
"mms_image_url": null
}
],
"created_at": "2025-05-28T10:15:30",
"updated_at": "2025-06-01T08:00:00"
}
]
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
Schedules (v2)
List Schedules
Retrieve all schedules for the authenticated account.
GET
/
v2
/
schedules
{
"schedules": [
{
"id": "6651a3f2e4b0a1c2d3e4f567",
"name": "Weekend Promo Blast",
"status": "on",
"send_type": "blast",
"source_lists": [101, 204],
"audiences": ["665fa1b2c3d4e5f6a7b8c901"],
"is_repeating": true,
"send_time": "14:30",
"send_date": null,
"start_date": "2025-06-01T00:00:00",
"end_date": "2025-08-31T00:00:00",
"days_of_week": {
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": true,
"saturday": true,
"sunday": true
},
"skip_within_hours": 24,
"use_local_time": true,
"filter_bots": true,
"is_transactional": false,
"is_mms": false,
"is_cto": false,
"automated_percent": 0,
"ir_revenue": 2.50,
"blasts": [
{
"message": "Flash sale this weekend! Shop now: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 60,
"variant_name": "Control",
"mms_image_url": null
},
{
"message": "Don't miss out — 20% off everything: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 40,
"variant_name": "Urgency Variant",
"mms_image_url": null
}
],
"created_at": "2025-05-28T10:15:30",
"updated_at": "2025-06-01T08:00:00"
}
]
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
List all schedules associated with your account. Returns all non-archived schedules by default. Use the
status filter to include archived schedules or narrow results to a specific status.
No pagination is applied — the full list of matching schedules is returned in a single response.
Query Parameters
Comma-separated list of statuses to filter by. Allowed values:
draft, off, on, complete, archive. When omitted, all schedules except those with status archive are returned.Response Fields
An array of schedule objects.
Show Schedule object properties
Show Schedule object properties
Which days the repeating schedule is active. Contains boolean fields:
monday, tuesday, wednesday, thursday, friday, saturday, sunday.Read-only.
true when this schedule is marked transactional. Messages from a transactional schedule bypass the standard SMS sending-hour window, state quiet-hour and holiday rules, and your account’s contact frequency caps. This field can only be set from the Trackly dashboard, where an account owner must explicitly acknowledge that bypass — it cannot be set through this API.Array of blast variant objects.
Show Blast object properties
Show Blast object properties
Array of offer link objects. Each contains
key (string, e.g. link1), offer_id (string, null when the link uses a custom URL), offer_source (string, the source discriminator for offer_id: sms for an offer in your account’s offer library, oms for a partnership offer), product_id (string, null when the link does not point to a product), variant_id (string, null when the link does not point to a specific product variant), custom_url (string, null when the link uses an offer), and url_params (object of key/value query parameters).Examples
cURL
curl -X GET "https://api.tracklysms.com/api/v2/schedules?status=on,draft&send_type=blast" \
-H "X-Api-Key: trk_your_api_key_here"
Python
import requests
response = requests.get(
"https://api.tracklysms.com/api/v2/schedules",
headers={"X-Api-Key": "trk_your_api_key_here"},
params={
"status": "on,draft",
"send_type": "blast"
}
)
data = response.json()
for schedule in data["schedules"]:
print(f"{schedule['name']} — {schedule['status']}")
Node.js
const response = await fetch(
"https://api.tracklysms.com/api/v2/schedules?status=on,draft&send_type=blast",
{
method: "GET",
headers: {
"X-Api-Key": "trk_your_api_key_here"
}
}
);
const data = await response.json();
data.schedules.forEach(schedule => {
console.log(`${schedule.name} — ${schedule.status}`);
});
{
"schedules": [
{
"id": "6651a3f2e4b0a1c2d3e4f567",
"name": "Weekend Promo Blast",
"status": "on",
"send_type": "blast",
"source_lists": [101, 204],
"audiences": ["665fa1b2c3d4e5f6a7b8c901"],
"is_repeating": true,
"send_time": "14:30",
"send_date": null,
"start_date": "2025-06-01T00:00:00",
"end_date": "2025-08-31T00:00:00",
"days_of_week": {
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": true,
"saturday": true,
"sunday": true
},
"skip_within_hours": 24,
"use_local_time": true,
"filter_bots": true,
"is_transactional": false,
"is_mms": false,
"is_cto": false,
"automated_percent": 0,
"ir_revenue": 2.50,
"blasts": [
{
"message": "Flash sale this weekend! Shop now: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 60,
"variant_name": "Control",
"mms_image_url": null
},
{
"message": "Don't miss out — 20% off everything: {{link1}}",
"offer_links": [
{
"key": "link1",
"offer_id": "665fa1b2c3d4e5f6a7b8c902",
"offer_source": "sms",
"product_id": null,
"variant_id": null,
"custom_url": null,
"url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
}
],
"percent_audience": 40,
"variant_name": "Urgency Variant",
"mms_image_url": null
}
],
"created_at": "2025-05-28T10:15:30",
"updated_at": "2025-06-01T08:00:00"
}
]
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
| 401 | invalid_credentials | API key is missing, invalid, or revoked. |
| 403 | account_suspended | Your account is suspended. Resolve outstanding billing or contact support. |
Next Steps
Campaign Scheduling
Plan and schedule campaigns
List Audiences
View available audiences