SMS

Cancel a send-list job

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

Stops a queued or running send-list job.

The job stops at the end of its current batch and gets the status stopped. Messages that are already queued are still sent. You can cancel only a job with status queued or running.

Body params (form)

  • job_idintegerrequired

    The job_id returned by Send SMS to a list.

Responses

  • 200The job is stopped
  • 400job_id is missing, or the job is already finished. The other message is "Required parameter [job_id] is missing".
  • 401The API key is missing, wrong or the account is blocked
  • 404No job with this ID on your account
curl -X POST "https://api.smsedge.com/v1/sms/send-list-cancel/" \
  -H "X-API-KEY: YOUR_API_KEY" \
  --data-urlencode "job_id=1532"
[
  {
    "success": true,
    "data": {
      "job_id": 1532,
      "list_id": 2070,
      "status": "stopped",
      "total": 17250,
      "queued": 9500,
      "failed": 2,
      "skipped": 0,
      "date_created": "2026-11-16 14:12:40",
      "started_at": "2026-11-16 14:12:41",
      "finished_at": "2026-11-16 14:13:45",
      "errors": [],
      "message": "Job stopped. Messages already queued will still be sent."
    },
    "errors": [],
    "response": {
      "code": 200,
      "description": "OK",
      "date": "2026-11-16 14:13:45"
    },
    "api": {
      "version": "v1",
      "module": "sms",
      "function": "send-list-cancel"
    },
    "user": {
      "id": 736
    }
  }
]

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