API Reference
Messages (v2)
Contacts (v2)
Creatives (v2)
Audiences (v2)
Schedules (v2)
Revenue (v2)
Data Import (v2)
Links (v2)
Webhooks (v2)
curl -X GET "https://app.tracklysms.com/api/v2/creatives?status=active&creative_type=automated&page=1&per_page=25" \
-H "X-Api-Key: trk_your_api_key_here"
{
"creatives": [
{
"id": 101,
"name": "Summer Sale Promo",
"message": "Hot deals just for you! Shop now: {{link1}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_abc123",
"url": null,
"url_params": {"sub1": "sms"}
}
],
"offers": ["offer_abc123"],
"status": "active",
"creative_type": "automated",
"character_count": 97,
"segment_count": 1,
"created_at": "2025-06-10T12:00:00Z"
},
{
"id": 102,
"name": "New Arrivals Alert",
"message": "Check out what just dropped: {{link1}} See more: {{link2}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_def456",
"url": null,
"url_params": {}
},
{
"key": "link2",
"offer_id": "offer_ghi789",
"url": "https://example.com/new",
"url_params": {}
}
],
"offers": ["offer_def456", "offer_ghi789"],
"status": "active",
"creative_type": "automated",
"character_count": 120,
"segment_count": 1,
"created_at": "2025-06-12T08:30:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 2,
"total_pages": 1
}
}
Creatives (v2)
List All Creatives
Retrieve a paginated list of all creatives in your account.
GET
/
v2
/
creatives
curl -X GET "https://app.tracklysms.com/api/v2/creatives?status=active&creative_type=automated&page=1&per_page=25" \
-H "X-Api-Key: trk_your_api_key_here"
{
"creatives": [
{
"id": 101,
"name": "Summer Sale Promo",
"message": "Hot deals just for you! Shop now: {{link1}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_abc123",
"url": null,
"url_params": {"sub1": "sms"}
}
],
"offers": ["offer_abc123"],
"status": "active",
"creative_type": "automated",
"character_count": 97,
"segment_count": 1,
"created_at": "2025-06-10T12:00:00Z"
},
{
"id": 102,
"name": "New Arrivals Alert",
"message": "Check out what just dropped: {{link1}} See more: {{link2}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_def456",
"url": null,
"url_params": {}
},
{
"key": "link2",
"offer_id": "offer_ghi789",
"url": "https://example.com/new",
"url_params": {}
}
],
"offers": ["offer_def456", "offer_ghi789"],
"status": "active",
"creative_type": "automated",
"character_count": 120,
"segment_count": 1,
"created_at": "2025-06-12T08:30:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 2,
"total_pages": 1
}
}
Returns all creatives for your account with support for filtering by status and creative type. Results are paginated.
Query Parameters
Filter creatives by status. Accepted values:
active, paused, archived.Filter creatives by type. Accepted values:
automated, one_time, welcome. When omitted, all types are returned.The page number to return.
Number of creatives per page. Maximum:
100.Response Fields
Array of creative objects.
Show Creative object properties
Show Creative object properties
Unique identifier for the creative.
Display name of the creative.
The message template. Contains
{{linkN}} placeholders (e.g. {{link1}}, {{link2}}) that are replaced with tracked short links at send time.Array of offer link objects that map to placeholders in the message.
Show Offer link properties
Show Offer link properties
The placeholder key (e.g.
link1). Corresponds to {{link1}} in the message.The ID of the offer associated with this link.
Optional URL override. When set, this URL is used instead of the offer’s default URL.
Optional additional query parameters appended to the link URL.
Array of offer ID strings referenced by this creative.
Current status. One of:
active, paused, archived.The type of creative. One of:
automated, one_time, welcome.Estimated character count of the rendered message. Link placeholders are estimated as 23 characters, and 34 characters of compliance overhead are added.
Estimated number of SMS segments. 1 segment if total characters are 160 or fewer; otherwise
ceil(total / 153).ISO 8601 timestamp of when the creative was created.
Examples
curl -X GET "https://app.tracklysms.com/api/v2/creatives?status=active&creative_type=automated&page=1&per_page=25" \
-H "X-Api-Key: trk_your_api_key_here"
{
"creatives": [
{
"id": 101,
"name": "Summer Sale Promo",
"message": "Hot deals just for you! Shop now: {{link1}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_abc123",
"url": null,
"url_params": {"sub1": "sms"}
}
],
"offers": ["offer_abc123"],
"status": "active",
"creative_type": "automated",
"character_count": 97,
"segment_count": 1,
"created_at": "2025-06-10T12:00:00Z"
},
{
"id": 102,
"name": "New Arrivals Alert",
"message": "Check out what just dropped: {{link1}} See more: {{link2}} Reply STOP to opt out.",
"offer_links": [
{
"key": "link1",
"offer_id": "offer_def456",
"url": null,
"url_params": {}
},
{
"key": "link2",
"offer_id": "offer_ghi789",
"url": "https://example.com/new",
"url_params": {}
}
],
"offers": ["offer_def456", "offer_ghi789"],
"status": "active",
"creative_type": "automated",
"character_count": 120,
"segment_count": 1,
"created_at": "2025-06-12T08:30:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 2,
"total_pages": 1
}
}
Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
| 401 | unauthorized | API key is missing or invalid. |
| 400 | invalid_status | The provided status value is not one of the accepted values. |
| 400 | invalid_creative_type | The provided creative_type value is not one of the accepted values. |
Next Steps
Creative Templates
Design effective message templates
Create Schedule
Use creatives in a scheduled campaign
⌘I