Sign in
VoucherPurchases

Preview a voucher recipient email

Renders the gift email that would be sent to a voucher recipient without dispatching it. Use this in operator UIs to show staff exactly what the recipient will see — including the rendered HTML body, sender, subject and CC/BCC list — before they commit to sending.

Pass recipient overrides in the body to preview against a different address (for example, a staff test inbox).

post/shop/voucher-purchases/{voucherPurchaseId}/preview-email

Request body

recipient_emailstring email

Override the recipient email address. Defaults to the purchase's stored recipient email if omitted.

recipient_namestring

Override the recipient name shown in the email greeting. Defaults to the purchase's stored recipient name if omitted.

Example request

{
  "recipient_email": "jane@example.com",
  "recipient_name": "Jane Jenkins"
}

Response

A preview-ready transactional email built from the voucher purchase. Returned by both the preview and send endpoints.

Example response

{
  "data": {
    "from": {
      "address": "jane@example.com",
      "name": "Jane Jenkins"
    },
    "to": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "cc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "bcc": [
      {
        "address": "jane@example.com",
        "name": "Jane Jenkins"
      }
    ],
    "subject": "Your spa day voucher is here!",
    "html": "<html><body>Enjoy your day!</body></html>"
  }
}

Changes

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