trk_[32-char-alphanumeric] (e.g., trk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6).
A key created with sandbox: true is a sandbox (test) key. Requests authenticated with a sandbox key are simulated — nothing is delivered and nothing is billed. Toggle this when creating the key from Settings > API Keys or by passing "sandbox": true in the create-key request body.
Getting Your API Key
1
Navigate to API Keys
Log into the Trackly SMS Dashboard and go to Settings > API Keys
2
Create a New Key
Click Create API Key and give it a descriptive name (e.g., “Production API”, “Development”)
3
Copy Your Key
Copy the API key immediately - it won’t be shown again
Using Your API Key
Include your API key in theX-Api-Key header with every request:
As an alternative, you can pass the same key in an
Authorization: Bearer <key> header (e.g. Authorization: Bearer trk_your_api_key_here). If both X-Api-Key and Authorization: Bearer are present, X-Api-Key takes precedence. X-Api-Key remains the recommended header.Authentication Errors
If authentication fails, you’ll receive a401 Unauthorized or 403 Forbidden response:
- Missing API Key
- Invalid API Key
- Account Suspended
401Account suspension is enforced at request time, not at API key creation time. A suspended account whose API keys were active before suspension will start receiving
403 Account is suspended on every call immediately after the admin action, without waiting for any cache or token to expire.Product Access Errors
Some endpoints are gated by per-account product entitlements. If your account isn’t enabled for a given product, requests to that product’s endpoints return403 Forbidden with a {product}_not_enabled code:
code follows the pattern {product}_not_enabled (e.g. email_not_enabled, partnerships_not_enabled). To enable a product on your account, contact support@tracklysms.com. SMS sending endpoints are enabled for all active accounts by default and do not return this error.
API Key Best Practices
Use Environment Variables
Store API keys in environment variables, not in code
Rotate Regularly
Create new keys periodically and revoke old ones
Separate Environments
Use different keys for development and production
Monitor Usage
Check the “Last Used” timestamp to detect unauthorized use
Managing API Keys
From the API Keys page in the dashboard, you can:Deleting an API key immediately invalidates it. Any requests using that key will fail with a
401 error.Linking Discord with API Keys
If you use our Discord integration, you can link your Discord account to your Trackly account using an API key:- View usage and balance from Discord
- Create and manage support tickets
- Receive real-time alerts
Next Steps
V2 API Overview
Explore all v2 endpoints
Send First SMS
Send your first message