Sign in
Orders

Send an email for an order

Send an email to the customer for an order. The type field selects which templated mailable is rendered — for example BookingConfirmation or BookingReminder. The list of available types is determined by the mailables configured in the application.

To render the email without actually sending it, use the Preview an order email endpoint instead.

post/shop/orders/{orderId}/emails

Request body

typestring required

The mailable type to send. This selects the underlying template; available types depend on the organisation's configured mailables.

contentstring

Optional custom message body to inject into the template. HTML is not permitted — submit plain text only.

paramsobject

Additional template parameters to pass through to the mailable — the available keys depend on the chosen type.

Example request

{
  "type": "BookingConfirmation",
  "content": "Looking forward to welcoming you on Saturday!"
}

Response

The email message was successfully sent.

Example response

{
  "data": {
    "id": "5ed2b95f72823c4f98419f19",
    "organisation_id": "5ed2b95f72823c4f98419f10",
    "site_id": "5ed2b95f72823c4f98419f11",
    "customer_id": "5ed2b95f72823c4f98419f12",
    "basket_id": "5ed2b95f72823c4f98419f13",
    "from": "bookings@example-spa.com",
    "to": [
      "jane.doe@example.com"
    ],
    "subject": "Your booking is confirmed",
    "type": "BookingConfirmation",
    "created_at": "2024-02-02T12:00:00+00:00",
    "sent_at": "2024-02-02T12:00:01+00:00",
    "delivered_at": "2024-02-02T12:00:05+00:00",
    "opened": true
  }
}

Changes

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