Cancel a scheduled outbound message
Cancels a scheduled outbound send before it fires, by messageId.
Cancels a scheduled outbound send before it fires, by messageId. This succeeds only while the message is still in scheduled status; the response is the message with status: canceled and a canceledAt timestamp. If the send has already left scheduled — sent, queued, canceled, or unknown — the call returns 409. Cancellation stops only the future dispatch and emits no webhook event. Requires the messages:send scope.
Scope: messages:send. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
messageId | string | yes | The outbound email id to cancel. |
Response
200 Success. Body: application/json, CancelOutboundMessageResponse.
| Field | Type | Required | Description |
|---|---|---|---|
message | OutboundMessage | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
409 | The resource already exists or its state does not allow this (duplicate_resource or a condition-specific code). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Bulk-delete many mailbox messages in a single call
Permanently deletes up to 1000 mailbox messages named in messageIds in one call, removing each message and its stored bytes — the raw email plus every attachment.
List delivery events for a message
Returns the delivery-event timeline for one outbound send, newest first — the delivery, bounce, and complaint events observed after the message was accepted for delivery.