Email

Cancel a scheduled email

An email that is still scheduled will not be sent. Once it is sent (or sending) it cannot be canceled (conflict).

post/scheduled-emails/{id}/cancel

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/scheduled-emails/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:write)

Path parameters

idstring uuid required

The id of the scheduled email.

Response

Canceled.

idstring uuid required

The id of the scheduled email. cancel_scheduled_email takes it.

source'api' | 'automation' | 'sequence' | 'list' | 'confirmation' required

api: send_email with send_at. automation, sequence, list: sent by those. confirmation: the confirmation email of a list.

status'scheduled' | 'sending' | 'sent' | 'canceled' | 'skipped' | 'failed' required

scheduled (waits for send_at), sending, sent (email_id is the email), canceled, skipped (the person unsubscribed or left the list or sequence), failed (reason says why).

send_atstring date-time required
tostring nullable required
subjectstring nullable required
template_idstring uuid nullable required
email_idstring uuid nullable required

The email once it was sent; get_email shows whether it was delivered.

reasonstring nullable required
testboolean required
created_atstring date-time required

Changes

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