Sending

Cancel a scheduled send

Changed on

Cancels a STILL-SCHEDULED send (status scheduled), moving it to the terminal canceled status. Nothing is dispatched and the row is kept for historical lookup with canceled_at set.

Uses the same compare-and-swap guard as reschedule: once the scheduler has claimed the row for execution, or it was already canceled or executed, the call returns a 409 not_scheduled conflict naming the row's current status. Canceling can therefore never race an in-progress execution; a send that reports canceled was never handed to the delivery path.

Returns the full updated sent-email record on success.

post/sent-emails/{id}/cancel

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/sent-emails/{id}/cancel
  • Auth: HTTP bearer

Response

Canceled sent-email detail

successboolean required

Changes

  • 294207b6de5fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status