Emails

Cancel or reschedule an email

Cancel a scheduled or queued email, or move it to a new send time. Only emails that haven't been handed off for delivery yet can be changed — once an email is sent this returns 409. Look up the email's current state first with Retrieve an email. Requires the emails:send capability.

patch/email/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/{id}
  • Auth: HTTP bearer

Request body

canceltrue
scheduled_atstring date-time

Response

The updated email.

object'email' required
idstring required
tostring[] required
fromstring required
subjectstring required
template_idstring nullable required
campaign_idstring nullable required
status'scheduled' | 'queued' | 'sent' | 'delivered' | 'bounced' | 'complained' | 'canceled' | 'failed' required
last_eventstring required
scheduled_atstring nullable required
sent_atstring nullable required
delivered_atstring nullable required
opened_atstring nullable required
clicked_atstring nullable required
canceled_atstring nullable required
last_errorstring nullable required
created_atstring required

Changes

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