coss.comdocs

Cancel a scheduled SMS

POST
/v1/sms/{id}/cancel

Cancels a message scheduled with scheduled_at before it is sent. Canceling a canceled message returns it as is.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

id*string

The message's id.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The canceled message.

application/json
  1. response
object*"sms"
Value in"sms"
id*string
from*string
to*string
body*string
status*string

queued until handed to the carrier (sent), then delivered or undelivered once the carrier reports. failed: never sent. scheduled and canceled: scheduled sends.

Value in"queued""scheduled""sent""delivered""undelivered""failed""canceled"
segments*integer

Segments the body takes (what is billed).

encoding*string
Value in"gsm7""ucs2"
country*string

ISO 3166 country of to.

tags*array<>
failure*|

Why the message failed or wasn't delivered.

sandbox*boolean

Sent from a sandbox environment: simulated.

scheduled_at*|
Formatdate-time
sent_at*|
Formatdate-time
delivered_at*|
Formatdate-time
created_at*string
Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.sms.cancel("sms_01k7c8m4q2f3e9v6t5r1n0p8yz");
{  "object": "sms",  "id": "sms_01k7c8m4q2f3e9v6t5r1n0p8yz",  "from": "+14155550123",  "to": "+14155550199",  "body": "Your Acme code is 482913",  "status": "delivered",  "segments": 1,  "encoding": "gsm7",  "country": "US",  "tags": [    {      "name": "flow",      "value": "sign_in"    }  ],  "failure": null,  "sandbox": false,  "scheduled_at": null,  "sent_at": "2026-11-10T12:00:01.000Z",  "delivered_at": "2026-11-10T12:00:04.000Z",  "created_at": "2026-11-10T12:00:00.000Z"}