v20

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01970424.3 KB

Emails

Update email outbox entry

Updates an email in the outbox. Can be used to edit email content, pause/resume, or cancel emails. Only emails in editable states (paused, preparing, rendering, render-error, scheduled, queued, server-error) can be modified.

patch/emails/outbox/{id}

Path parameters

idstring

Query parameters

statusstring

simple_statusstring

Request body

tsx_sourcestring

theme_id'null' nullable

toobject

variablesobject

skip_deliverability_checkboolean

scheduled_at_millisnumber

is_pausedboolean

cancelboolean

Example request

{}

Response

Successful response

{"stackTrail":"paths:/emails/outbox/{id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}