HEhexclave
Emails

Update email outbox entry

Changed on

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}

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/emails/outbox/{id}
  • Auth
    none declared

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

unknown required

Changes

  • c4c6162ab77fRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      the request property became nullable

    • info

      added the new undefined enum value to the request property