---
title: "Preview an order email"
method: POST
path: "/shop/orders/{orderId}/emails/preview"
tags: ["Orders"]
---

# Preview an order email

`POST /shop/orders/{orderId}/emails/preview`

Render an email for an order without actually sending it. Useful for
showing users a preview of the message that will be sent — for example
in the order detail UI before confirming a manual send.

## Request body

- object
  - `type` string, required — The mailable type to preview.
  - `content` string — Optional custom message body to inject into the template. HTML is not permitted — submit plain text only.
  - `params` object — Additional template parameters to pass through to the mailable — the available keys depend on the chosen `type`.

## Response `200`

The email message was successfully retrieved.

- object
  - `data` OrderEmailMessage, required — A rendered email message — either retrieved from history or generated as a preview prior to sending.
    - `from` string, nullable — The "from" address of the email message.
    - `to` string[] — The recipients of the email message.
    - `cc` string[], nullable — The CC recipients of the email message.
    - `bcc` string[], nullable — The BCC recipients of the email message.
    - `subject` string, required — The subject line of the email message.
    - `email_type` string, required — The class name of the underlying mailable that produced this email — for example `BookingConfirmation`.
    - `html` string, required — The fully rendered HTML body of the email message.

## Other responses

- `400` — The request failed.
- `404` — The resource couldn't be found
- `422` — The request didn't pass validation

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)