PRprimitive
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

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Response

Canceled sent-email detail

successtrue required

Changes

  • 0360ea8d4f3dRevision changes
    • warning

      added the new agent_changed enum value to the / response property for the response status

    • warning

      added the new agent_changed enum value to the / response property for the response status

    • warning

      added the new agent_changed enum value to the / response property for the response status

    • warning

      added the new agent_changed enum value to the / response property for the response status

    • warning

      added the new agent_limit enum value to the / response property for the response status

    • warning

      added the new agent_limit enum value to the / response property for the response status

    • warning

      added the new agent_limit enum value to the / response property for the response status

    • warning

      added the new agent_limit enum value to the / response property for the response status

    • warning

      added the new already_member enum value to the / response property for the response status

    • warning

      added the new already_member enum value to the / response property for the response status

    • warning

      added the new already_member enum value to the / response property for the response status

    • warning

      added the new already_member enum value to the / response property for the response status

    • warning

      added the new directory_limit enum value to the / response property for the response status

    • warning

      added the new directory_limit enum value to the / response property for the response status

    • warning

      added the new directory_limit enum value to the / response property for the response status

    • warning

      added the new directory_limit enum value to the / response property for the response status

    • warning

      added the new invitation_accepted enum value to the / response property for the response status

    • warning

      added the new invitation_accepted enum value to the / response property for the response status

    • warning

      added the new invitation_accepted enum value to the / response property for the response status

    • warning

      added the new invitation_accepted enum value to the / response property for the response status

    • warning

      added the new invitation_changed enum value to the / response property for the response status

    • warning

      added the new invitation_changed enum value to the / response property for the response status

    • warning

      added the new invitation_changed enum value to the / response property for the response status

    • warning

      added the new invitation_changed enum value to the / response property for the response status

    • warning

      added the new invitation_pending enum value to the / response property for the response status

    • warning

      added the new invitation_pending enum value to the / response property for the response status

    • warning

      added the new invitation_pending enum value to the / response property for the response status

    • warning

      added the new invitation_pending enum value to the / response property for the response status

    • warning

      added the new invitation_sending enum value to the / response property for the response status

    • warning

      added the new invitation_sending enum value to the / response property for the response status

    • warning

      added the new invitation_sending enum value to the / response property for the response status

    • warning

      added the new invitation_sending enum value to the / response property for the response status

    • warning

      added the new invitation_unconfirmed enum value to the / response property for the response status

    • warning

      added the new invitation_unconfirmed enum value to the / response property for the response status

    • warning

      added the new invitation_unconfirmed enum value to the / response property for the response status

    • warning

      added the new invitation_unconfirmed enum value to the / response property for the response status

    • warning

      added the new invitations_pending enum value to the / response property for the response status

    • warning

      added the new invitations_pending enum value to the / response property for the response status

    • warning

      added the new invitations_pending enum value to the / response property for the response status

    • warning

      added the new invitations_pending enum value to the / response property for the response status

    • warning

      added the new member_changed enum value to the / response property for the response status

    • warning

      added the new member_changed enum value to the / response property for the response status

    • warning

      added the new member_changed enum value to the / response property for the response status

    • warning

      added the new member_changed enum value to the / response property for the response status

    • warning

      added the new project_changed enum value to the / response property for the response status

    • warning

      added the new project_changed enum value to the / response property for the response status

    • warning

      added the new project_changed enum value to the / response property for the response status

    • warning

      added the new project_changed enum value to the / response property for the response status

    • warning

      added the new recipient_changed enum value to the / response property for the response status

    • warning

      added the new recipient_changed enum value to the / response property for the response status

    • warning

      added the new recipient_changed enum value to the / response property for the response status

    • warning

      added the new recipient_changed enum value to the / response property for the response status

  • 5279a7bed7acRevision changes
    • warning

      added the new archive_busy enum value to the / response property for the response status

    • warning

      added the new archive_busy enum value to the / response property for the response status

    • warning

      added the new archive_busy enum value to the / response property for the response status

    • warning

      added the new archive_busy enum value to the / response property for the response status

    • warning

      added the new archive_invalid enum value to the / response property for the response status

    • warning

      added the new archive_invalid enum value to the / response property for the response status

    • warning

      added the new archive_invalid enum value to the / response property for the response status

    • warning

      added the new archive_invalid enum value to the / response property for the response status

    • warning

      added the new archive_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new archive_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new archive_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new archive_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new archive_unsafe_path enum value to the / response property for the response status

    • warning

      added the new archive_unsafe_path enum value to the / response property for the response status

    • warning

      added the new archive_unsafe_path enum value to the / response property for the response status

    • warning

      added the new archive_unsafe_path enum value to the / response property for the response status

    • warning

      added the new archive_unsupported enum value to the / response property for the response status

    • warning

      added the new archive_unsupported enum value to the / response property for the response status

    • warning

      added the new archive_unsupported enum value to the / response property for the response status

    • warning

      added the new archive_unsupported enum value to the / response property for the response status

    • warning

      added the new attachment_name_ambiguous enum value to the / response property for the response status

    • warning

      added the new attachment_name_ambiguous enum value to the / response property for the response status

    • warning

      added the new attachment_name_ambiguous enum value to the / response property for the response status

    • warning

      added the new attachment_name_ambiguous enum value to the / response property for the response status

    • warning

      added the new attachment_not_archive enum value to the / response property for the response status

    • warning

      added the new attachment_not_archive enum value to the / response property for the response status

    • warning

      added the new attachment_not_archive enum value to the / response property for the response status

    • warning

      added the new attachment_not_archive enum value to the / response property for the response status

    • warning

      added the new latest_message_mismatch enum value to the / response property for the response status

    • warning

      added the new latest_message_mismatch enum value to the / response property for the response status

    • warning

      added the new latest_message_mismatch enum value to the / response property for the response status

    • warning

      added the new latest_message_mismatch enum value to the / response property for the response status

    • warning

      added the new latest_message_thread_unresolved enum value to the / response property for the response status

    • warning

      added the new latest_message_thread_unresolved enum value to the / response property for the response status

    • warning

      added the new latest_message_thread_unresolved enum value to the / response property for the response status

    • warning

      added the new latest_message_thread_unresolved enum value to the / response property for the response status

    • warning

      added the new sent_mail_search_unavailable enum value to the / response property for the response status

    • warning

      added the new sent_mail_search_unavailable enum value to the / response property for the response status

    • warning

      added the new sent_mail_search_unavailable enum value to the / response property for the response status

    • warning

      added the new sent_mail_search_unavailable enum value to the / response property for the response status

    • warning

      added the new thread_busy enum value to the / response property for the response status

    • warning

      added the new thread_busy enum value to the / response property for the response status

    • warning

      added the new thread_busy enum value to the / response property for the response status

    • warning

      added the new thread_busy enum value to the / response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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