API Reference

Welcome to the Platform API documentation. Browse the available endpoints below.

Authentication All requests require a Bearer token in the Authorization header. The token is 56 characters long and is tied to your account.

Campaigns

Create SMS Campaign
POST /api/v1/{account_code}/campaigns/sms/create
Create and schedule an SMS campaign targeting a contact list with sender, message text and tracked shortlink.

SMS

Transactional SMS Send
POST /api/v1/{account_code}/sms/transactional/send/
Send personalized SMS to one or more recipients with variable text, tracked links and scheduling.
SMS Sender Registration
POST /api/v1/{account_code}/sms/senders/registration-requests/
Submit a registration request for an alphanumeric SMS sender in one or more countries.

Contacts

Lists Create
POST /api/v1/{account_code}/lists/create
Create a new contact list with category, reminder and company details. Returns the list_id to upload contacts in the next step.
Get All Lists
GET /api/v1/{account_code}/lists/get-all/
Retrieve all account contact lists with name, category, status and contact count.