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}

Update email outbox entry

cURL

curl --request PATCH \
  --url https://api.stack-auth.com/api/v1/emails/outbox/{id} \
  --header 'Content-Type: application/json' \
  --data '{}'

Path Parameters

id · string

Query Parameters

status · string

simple_status · string

Body

application/json

tsx_source · string

theme_id · string

to · object

variables · object

skip_deliverability_check · boolean

scheduled_at_millis · number

is_paused · boolean

cancel · boolean

Response

200 - application/json

Successful response