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.
This page explains the core entities in Trackly SMS and how they relate to each other.
Entity Overview
Account (root tenant)
├── SendingList (phone number + config)
│ └── ListContact (subscription state)
│ └── Contact (global phone record)
├── Audience (segment definition)
├── Schedule (campaign)
├── MessageCreative (template)
├── WelcomeJourney (automation)
├── Offer (affiliate offer)
└── User (team member)
Account
The Account is your organization’s workspace. It’s the root container for all your data.
| Field | Description |
|---|
| Name | Organization name |
| Owner email | Primary contact |
| Status | active, suspended, deleted |
| Settings | Messaging config, bot filtering |
SendingList
A SendingList represents a phone number configuration.
| Field | Description |
|---|
| Phone number | The “from” number |
| Provider | Infobip, Twilio, etc. |
| Brand name | Display name |
| Credentials | Provider-specific config |
| Status | active, inactive |
| Field | Description |
|---|
| Phone number | E.164 format |
| Carrier | Detected carrier |
| Line type | cell, VOIP, landline |
| Timezone | Derived from area code |
| Field | Description |
|---|
| Status | active, unsubscribed |
| Signup date | When they joined |
| Signup method | API, import, form |
| Custom fields | Account-defined data |
| Activity stats | Denormalized metrics |
last_sent_at, last_clicked_atsend_count, click_countrevenue_total, conversion_count
Audience
An Audience defines a segment of contacts using filter conditions.
| Field | Description |
|---|
| Name | Display name |
| Lists | Which lists to query |
| Conditions | Filter rules |
| Cached size | Estimated count |
Schedule
A Schedule is a campaign configuration.
| Field | Description |
|---|
| Name | Campaign name |
| Sending list | Which number to send from |
| Audiences | Who to target |
| Send type | blast, automated |
| Schedule config | One-time, recurring |
MessageCreative
A MessageCreative is a reusable message template.
| Field | Description |
|---|
| Body | Message text with placeholders |
| Offer bindings | Link → Offer mappings |
| Type | one_time, automated, welcome |
| Status | active, paused, archived |
| Performance | Sends, clicks, revenue |
WelcomeJourney
A WelcomeJourney is an automated sequence.
| Field | Description |
|---|
| Name | Journey name |
| Trigger conditions | When to enroll |
| Status | draft, active, paused |
Offer
An Offer represents an affiliate offer.
| Field | Description |
|---|
| Name | Offer name |
| Tracking URL | Destination |
| Payout | CPA/CPC amount |
| Source | TUNE, manual, etc. |
| Performance | Clicks, conversions |
MessageSent
A MessageSent records each sent message.
| Field | Description |
|---|
| Contact | Who received it |
| Creative | What template |
| Sending list | From number |
| Schedule | Campaign source |
| Status | queued, sent, delivered, failed |
MessageShortLink
A MessageShortLink is a tracked URL in a message.
| Field | Description |
|---|
| Link ID | Short code (7 chars) |
| Destination | Original URL |
| Offer | Associated offer |
User
A User is a person with dashboard access.
| Field | Description |
|---|
| Email | Login email |
| Status | Active, pending |
| Accounts | List of accessible accounts |
Relationships Diagram
┌─────────────┐
│ Account │
└──────┬──────┘
┌─────────────────┼─────────────────┐
▼ ▼ ▼
┌───────────┐ ┌───────────┐ ┌───────────┐
│SendingList│ │ Schedule │ │ Audience │
└─────┬─────┘ └─────┬─────┘ └───────────┘
│ │
▼ ▼
┌───────────┐ ┌───────────┐
│ListContact│ │ScheduleBlast│
└─────┬─────┘ └─────┬─────┘
│ │
▼ ▼
┌───────────┐ ┌───────────┐
│ Contact │ │ Creative │
└───────────┘ └─────┬─────┘
│
▼
┌───────────┐
│ Offer │
└───────────┘
Next Steps
Message Lifecycle
How messages flow through the system
Compliance
Opt-out and regulations
