emails

Cancel a scheduled or queued email.

Already-sent mail is history, not cancellable.

post/emails/{id}/cancel

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/emails/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Response

Success

object'email' required
idstring uuid required
fromstring required
tostring[] required
ccstring[] nullable required
bccstring[] nullable required
reply_tostring[] nullable required
subjectstring required
message_idstring nullable required
htmlstring nullable required
textstring nullable required
headersobject nullable required
tagsobject nullable required
scheduled_atstring date-time nullable required
status'queued' | 'scheduled' | 'sent' | 'delivered' | 'delivery_delayed' | 'bounced' | 'complained' | 'opened' | 'clicked' | 'failed' | 'canceled' | 'suppressed' required
last_event'queued' | 'scheduled' | 'sent' | 'delivered' | 'delivery_delayed' | 'bounced' | 'complained' | 'opened' | 'clicked' | 'failed' | 'canceled' | 'suppressed' nullable required
provider_message_idstring nullable required
api_key_idstring nullable required
template_idstring uuid nullable required
template_versioninteger nullable required
domainstring required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.