Mail API reference

Mail API · Emails

post/v1/workspaces/{workspace_id}/emails/{id}/cancelAuth

Cancel a scheduled email

Cancels a scheduled email before it goes out: every recipient's message reads `canceled` and gets an `email.canceled` event. Nothing is sent or counted.

Path parameters

workspace_id*string · uuid

Id of the workspace.

id*string · uuid

Id of the email.

Headers

Idempotency-Keystring

Opaque client-generated string (1–256 chars, `[A-Za-z0-9._:-]`) used to deduplicate retries within a 24h window. A retry with the same key and body returns the original response with `Idempotent-Replay: true`.

Response · 200

id*string · uuid

The email id.

status*object

Always `canceled`.

Example: "canceled"

Example

Request

POST https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/emails/{id}/cancel
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "canceled"
}