Order Controller

Send order email with selected template

Send order email using subject/body and any draft attachments previously staged via POST /orders/draft-attachments/:id. Draft attachments are merged automatically and cleared after a successful send. Optional applicationNumber: omit to leave unchanged, null to clear; non-empty values require a certified order (isCertified) and are persisted on the order after a successful send (not inserted into email body).

post/orders/send-email/{id}

Path parameters

idnumber required
Example:1

The ID of the entity

Request body

subjectstring

Custom subject for the email

bodystring

Custom body for the email (HTML supported). Use {{DOCUMENT_LINK}} for the document access button. Use {{UPSELL_LINK}} or {{upsellLink}} for the upsell checkout button when upSell product IDs are provided; if omitted, the upsell button is inserted after "link below" or appended to the body.

upSellnumber[]

Array of product IDs for upselling

isPostageboolean

When true and email is sent successfully, order status will be updated to Postage.

applicationNumberstring nullable

Certified orders only when non-empty. Omit to leave unchanged; null clears the stored value.

Example request

{
  "subject": "Your Order Confirmation",
  "body": "<p>Hello {{customerName}}, your order is being processed.</p><p>Access your documents:</p>{{DOCUMENT_LINK}}<p>{{UPSELL_LINK}}</p>",
  "upSell": [
    1,
    2
  ],
  "isPostage": true,
  "applicationNumber": "APP-12345"
}

Response

Email sent successfully

Changes

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