---
title: "Cancel a scheduled message"
method: POST
path: "/v1/messages/{id}/cancel"
tags: ["Messages"]
---

# Cancel a scheduled message

`POST /v1/messages/{id}/cancel`

## Request

- Base URL: `https://api.mails.ai`
- URL: `https://api.mails.ai/v1/messages/{id}/cancel`
- Auth: HTTP bearer

**Requires scope:** `manage` or `inbox` (`inbox` only in a signed-in dashboard session; no API key or app can hold it). Cancels a send that is still scheduled, so it is never sent. Once the send starts going out it can no longer be canceled: the cancel changes nothing and answers 409 `duplicate_resource`, also when the send started while the cancel was running. A test key cannot cancel a send a live key scheduled (403 `live_mode_required`).

## Path parameters

- `id` string, required

## Response `200`

The canceled message.

- object
  - `id` string, required: Id of the canceled message (`msg_…`): the id in the path.
  - `status` 'canceled', required: Always `canceled`: the message will not be sent. Only a scheduled message can be canceled.
  - `canceled_at` string, date-time, required: When the send was canceled: the time of this request, also kept as the message's `canceled_at`.

## Other responses

- `400`: Invalid request — malformed JSON or a field failed validation. Also `feature_not_enabled` when this server has a feature switched off (custom domains before they are available).
- `401`: Missing or invalid API key.
- `403`: The API key lacks the required scope (`insufficient_scope`), or the token belongs to an app connected by sign-in and this operation is closed to connected apps (`connected_app_not_allowed`).
- `404`: Resource not found in this workspace, or the agent a send names is archived (`agent_archived`).
- `409`: Conflict — duplicate resource, an in-progress idempotent request, a draft or scheduled message that started sending while it was being changed, or a thread deleted for good while one of its messages is being sent (`duplicate_resource`); or an agent name more than one agent has (`agent_name_conflict`: use the agent's id); or a status change on an archived agent, since archiving cannot be undone (`agent_archived`).
- `500`: Internal server error.

---

[API](https://skmtc.dev/mails/apis/mails-ai-api.md) · [All operations](https://skmtc.dev/mails/apis/mails-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mails/apis/mails-ai-api/revisions/4d4930a8c33b?raw)