Cancel a queued or scheduled send

DELETE
/v1/email/{id}

Requires Action::Manage (a full_access key).

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <key>. Looked up by SHA-256 hash (email_core::sha256_hex) against api_keys.hash; revoked keys and keys belonging to a suspended tenant are rejected. See the top-level Authentication section for permission levels.

Path Parameters

id*string

The message id returned by POST /v1/email(/batch).

Response Body

Cancelled.

application/json
  1. response
message_id?string
status?"cancelled"
Value in"cancelled"
curl -X DELETE "https://example.com/v1/email/string"
{  "message_id": "string",  "status": "cancelled"}