Cancel a scheduled email

POST
/v1/emails/{id}/cancel

Cancels an email sent with a future scheduled_at before it is sent. Canceling an already canceled email returns it unchanged. To send it at another time, reschedule it instead.

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 email'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 email.

application/json
  1. response
object*"email"
Value in"email"
id*string
from*string

Who it's sent from.

to*array<string>

The To addresses.

cc*array<string>

The Cc addresses.

bcc*array<string>

The Bcc addresses.

reply_to*array<string>

The Reply-To addresses.

subject*string

The subject, rendered if it came from a template.

html*|

The HTML part. null: none, or the body was discarded.

text*|

The plain text part. null: none, or the body was discarded.

headers*

The custom headers it was sent with.

tags*array<>

Your tags on the email.

category*|

The email's category, which suppressions and tracking rules can scope to. null: none.

stream*string

transactional or marketing.

Value in"transactional""marketing"
status*string

Whether the email was handed to the delivery provider. scheduled emails wait for scheduled_at; canceled ones were canceled before that. Per-recipient delivery is in recipients.

Value in"queued""sent""failed""scheduled""canceled"
failure*|

Why the email failed; null unless status is failed.

recipients*array<>

Each recipient, with how delivery to them went.

attachments*array<>

Attachment metadata. Content is never returned, and is discarded once sent.

sandbox*boolean

True when sent from a sandbox environment (never delivered).

tracking*

Open and click tracking, as resolved when the email was sent, with engagement so far. Opens can be inflated by mail clients that prefetch images, clicks by link scanners.

created_at*string
Formatdate-time
sent_at*|

When it was handed to the provider. null: not yet.

Formatdate-time
scheduled_at*|

When the email was scheduled to be sent; null if it was not.

Formatdate-time
batch_id*|

The batch that sent the email; null if it was sent on its own.

template*|

The template the email was rendered from; null if it was sent without one.

broadcast_id*|

The broadcast the email is part of; null for any other email.

subaccount_id*|

The sub-account the email was sent for; null if it was sent for none.

content_storage*

Whether coss.com keeps the email's content after sending it.

import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.cancel("email_01k7c8m4q2f3e9v6t5r1n0p8yz");
{  "object": "email",  "id": "email_01k7c8m4q2f3e9v6t5r1n0p8yz",  "from": "Acme <onboarding@acme.com>",  "to": [    "user@example.com"  ],  "cc": [],  "bcc": [],  "reply_to": [],  "subject": "Welcome to Acme",  "html": "<p>Thanks for signing up!</p>",  "text": null,  "headers": {},  "tags": [    {      "name": "template",      "value": "welcome"    }  ],  "category": "onboarding",  "stream": "transactional",  "status": "sent",  "failure": null,  "recipients": [    {      "address": "user@example.com",      "type": "to",      "status": "delivered",      "last_event_at": "2026-10-10T12:00:02.000Z"    }  ],  "sandbox": false,  "tracking": {    "opens": false,    "clicks": false,    "unsubscribe": false,    "open_count": 0,    "first_opened_at": null,    "last_opened_at": null,    "click_count": 0,    "first_clicked_at": null,    "last_clicked_at": null  },  "attachments": [],  "created_at": "2026-10-10T12:00:00.000Z",  "sent_at": "2026-10-10T12:00:01.000Z",  "scheduled_at": null,  "batch_id": null,  "template": null,  "broadcast_id": null,  "subaccount_id": null,  "content_storage": {    "mode": "store",    "discarded_at": null  }}