Create SMS Campaign

Create and schedule a new SMS campaign targeting a contact list.

POST /api/v1/{account_code}/campaigns/sms/create
Authorization Bearer {token}  — 56 characters

This endpoint creates a scheduled SMS campaign targeting a contact list. You can specify the sender, message text, send time, and an optional tracked shortlink.

Scheduled delivery The start parameter defines the campaign send date and time in YYYY-MM-DD HH:MM format. The campaign will be queued and sent at the specified time.

Parameters (JSON)

Parameter Required Type Description
campaign_name YES string Campaign name (e.g. "February 2026 Promo")
sender YES string Alphanumeric sender registered for your account (e.g. "MYSHOP")
list_id YES integer ID of the recipient contact list. Retrievable via lists/get-all/
sms_text YES string SMS message text to be sent to all contacts in the list
start YES string Scheduled send date and time. Format: YYYY-MM-DD HH:MM (e.g. "2026-02-25 10:30")
shortlink1 NO string URL to include in the message as a tracked shortlink. Leave empty ("") if not needed

Request Example

JSON 
{
  "campaign_name": "February 2026 Promo",
  "sender": "MYSHOP",
  "list_id": 123,
  "sms_text": "Hi! Don't miss our exclusive offer. Visit: {shortlink1}",
  "start": "2026-02-25 10:30",
  "shortlink1": "https://www.example.com/promo"
}

Success Response

201 Created
JSON 
{
  "success": true,
  "message": "SMS Campaign created successfully.",
  "data": {
    "campaign_name": "February 2026 Promo",
    "sender": "MYSHOP",
    "list_id": 123,
    "start": "2026-02-25 10:30:00",
    "created_at": "2026-02-24 09:15:00"
  }
}

Response Fields

Field Type Description
success boolean Operation result
message string Descriptive message
data.campaign_name string Campaign name
data.sender string Sender set for the campaign
data.list_id integer Recipient list ID
data.start string Scheduled send date/time (format: Y-m-d H:i:s)
data.created_at string Campaign creation date/time (format: Y-m-d H:i:s)

Common Errors

400 Bad Request
JSON 
{
  "success": false,
  "message": "Necessary data is missing."
}
403 Forbidden — Invalid token
JSON 
{
  "success": false,
  "message": "NO Token Found."
}

Full Flow: Get List + Create Campaign

1
Retrieve the recipient list ID
Request 
GET /api/v1/{account_code}/lists/get-all/

// → Response: { "data": [ { "list_id": 123, "name": "2026 Clients" } ] }
2
Create the campaign using the list_id
Request 
POST /api/v1/{account_code}/campaigns/sms/create

{
  "campaign_name": "February 2026 Promo",
  "sender": "MYSHOP",
  "list_id": 123,
  "sms_text": "Hi! Your exclusive offer is waiting for you.",
  "start": "2026-02-25 10:30",
  "shortlink1": ""
}

// → Response: { "success": true, ... "data": {"campaign_name": "February 2026 Promo", "sender": "MYSHOP", ...} }