Mailboxes

Cancel a mailbox send

Cancels a definitely unsent action and reopens its draft atomically. Only an authorized person who proposed the send or can approve actions may cancel. Accepted sends return 409 with their winning receipt and cannot be withdrawn. An uncertain send requires reconciliation and cannot be cancelled as unsent. Cancelling a send held for approval records resolution.outcome: cancelled and publishes one mailbox.action.resolved event.

post/v1/mailboxes/{id}/actions/{actionId}/cancel

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}/actions/{actionId}/cancel
  • Auth: API key in header x-api-key

Path parameters

idstring required
actionIdstring required

Response

MailboxSendReceipt

actionIdstring required
draftIdstring required
messageIdstring required
threadIdstring required
state'approvalRequired' | 'queued' | 'accepted' | 'completed' | 'notSent' | 'uncertain' required
acceptedAtstring nullable required
waitReason'rate' | 'daily-quota' | 'domain-health' | 'sending-paused' | 'upstream-unavailable' | 'retry' | 'campaign-paused' | 'domain-warming' | 'onboarding-review' | 'content-review' | 'screening-unavailable' nullable required
reviewExpectedAtstring nullable required
executeUntilstring nullable required
retryAtstring nullable required
retryEligibleboolean required
createdAtstring required
updatedAtstring required

Changes

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