SMS

Send SMS to a list

POSThttps://api.smsedge.com/v1/sms/send-list/

Sends the same SMS to every good number in one of your lists.

Only numbers with status good get the message. Unsubscribed, blacklisted and deleted numbers are skipped.

  • Small lists (200 good numbers or less): the messages are queued during the request. The response is 200 with the number of queued messages. errors lists the numbers that failed.
  • Large lists (more than 200 good numbers): one message is checked first, then a background job sends the list. The response is 202 with a job_id. Use Get send-list job status to follow it and Cancel a send-list job to stop it.

Only one job can run on a list at a time. Variables in the text ({{{name}}}, {{{lname}}}, {{{email}}}, {{{custom1}}} to {{{custom5}}}, {{{optout}}}) are filled from each number's data. The daily sending limit is checked again during a background job.

Body params (form)

  • list_idintegerrequired

    ID of the list to send to.

  • fromstringrequired

    Sender ID shown to the recipient. 15 characters max.

  • textstringrequired

    Message text. Variables are filled from each number's data.

  • shorten_urlintegeroptional

    1 replaces the first URL in the text with a click-tracked short link.

    Default: 1Values: 0, 1

  • smart_routingintegeroptional

    1 sends the messages through smart routes.

    Default: 0Values: 0, 1

  • preferred_route_idintegeroptional

    ID of the route to send through. Get IDs from List routes.

Responses

  • 200Small list: the messages are queued
  • 202Large list: a background job sends the list
  • 400The list cannot be sent. Other messages: "No good numbers found in list [2070]", and for large lists the check of the first message, for example "No routing to destination [to]" or "Insufficient Balance [token]".
  • 401The API key is missing, wrong or the account is blocked
  • 403The account cannot send now. The other message is "Account waiting activation".
  • 404The list does not exist, is hidden or is not yours
  • 409A send-list job is already queued or running for this list
curl -X POST "https://api.smsedge.com/v1/sms/send-list/" \
  -H "X-API-KEY: YOUR_API_KEY" \
  --data-urlencode "list_id=2070" \
  --data-urlencode "from=MyBrand" \
  --data-urlencode "text=Hi {{{name}}}, our sale ends tonight: https://example.com/sale"
[
  {
    "success": true,
    "data": [
      "7 message(s) have been sent"
    ],
    "errors": [],
    "response": {
      "code": 200,
      "description": "OK",
      "date": "2026-11-16 14:12:40"
    },
    "api": {
      "version": "v1",
      "module": "sms",
      "function": "send-list"
    },
    "user": {
      "id": 736
    }
  }
]

All requests need your API key in the X-API-KEY header. See Authentication.