Cancel or reschedule an email

PATCH/api/v1/email/{id}

PATCH /email/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/email_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "scheduled_at": null
  }'

Response · 200

{
  "object": "email",
  "id": "id_123",
  "to": [
    "customer@example.com"
  ],
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "template_id": "template_123",
  "campaign_id": "campaign_123",
  "status": "scheduled",
  "last_event": "string",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "sent_at": "2026-01-01T00:00:00.000Z",
  "delivered_at": "2026-01-01T00:00:00.000Z",
  "opened_at": "2026-01-01T00:00:00.000Z",
  "clicked_at": "2026-01-01T00:00:00.000Z",
  "canceled_at": "2026-01-01T00:00:00.000Z",
  "last_error": "string",
  "created_at": "2026-01-01T00:00:00.000Z"
}

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.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body2 fields

Field	Type	Description
`cancel`	boolean	—
`scheduled_at`	string	—

Response · 200 fields17 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`to`required	string[]	—
`from`required	string	—
`subject`required	string	—
`template_id`required	object	—
`campaign_id`required	object	—
`status`required	enumscheduled \| queued \| sent \| delivered \| bounced \| complained \| canceled \| failed	—
`last_event`required	string	—
`scheduled_at`required	object	—
`sent_at`required	object	—
`delivered_at`required	object	—
`opened_at`required	object	—
`clicked_at`required	object	—
`canceled_at`required	object	—
`last_error`required	object	—
`created_at`required	string	—

200401403404409422

Cancel or reschedule an email

Cancel or reschedule an email

Search docs and guides