---
title: "Cancel a scheduled email"
method: POST
path: "/scheduled-emails/{id}/cancel"
tags: ["Email"]
---

# Cancel a scheduled email

`POST /scheduled-emails/{id}/cancel`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/scheduled-emails/{id}/cancel`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `messages:write`)

An email that is still scheduled will not be sent. Once it is sent (or sending) it cannot be canceled (conflict).

## Path parameters

- `id` string, uuid, required

## Response `200`

Canceled.

- object
  - `id` string, uuid, required: The id of the scheduled email. cancel_scheduled_email takes it.
  - `source` 'api' | 'automation' | 'sequence' | 'list' | 'confirmation', required: api: send_email with send_at. automation, sequence, list: sent by those. confirmation: the confirmation email of a list.
  - `status` 'scheduled' | 'sending' | 'sent' | 'canceled' | 'skipped' | 'failed', required: scheduled (waits for send_at), sending, sent (email_id is the email), canceled, skipped (the person unsubscribed or left the list or sequence), failed (reason says why).
  - `send_at` string, date-time, required
  - `to` string, nullable, required
  - `subject` string, nullable, required
  - `template_id` string, uuid, nullable, required
  - `email_id` string, uuid, nullable, required: The email once it was sent; get_email shows whether it was delivered.
  - `reason` string, nullable, required
  - `test` boolean, required
  - `created_at` string, date-time, required

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `409`: Conflict: conflict.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)