---
title: "Render an email preview"
method: POST
path: "/engagement/emails/render-preview"
tags: ["Engagement Email"]
---

# Render an email preview

`POST /engagement/emails/render-preview`

## Request

- Base URL: `https://api.gleap.io/v3`
- URL: `https://api.gleap.io/v3/engagement/emails/render-preview`
- Auth: HTTP bearer

Render an email the way a recipient gets it, from unsaved editor values: `emailStyle`
(plain, personal or company), `subject`, `preheader`, `message` (TipTap JSON, or
`{ localized: { <lang>: doc } }`), optional `sender` (a teammate id, or
`{ customSenderName }`), `lang` and `brand` (unsaved `emailBrand` values). The current
user is the sample recipient and variables resolve with their values. Nothing is
stored or sent.

## Headers

- `project` string, required

## Request body

- RenderPreviewBody
  - `emailStyle` string, required
  - `subject` unknown
  - `preheader` unknown
  - `message` unknown
  - `sender` union: A teammate id, or `{ id?, customSenderName? }`. Defaults to the current user.
    - string
    - object
      - `customSenderName` string
      - `id` string
  - `lang` string
  - `brand` unknown
  - `emailCategory` 'conversational' | 'marketing': Conversational emails show no unsubscribe line. Defaults to marketing (a newsletter).

## Response `200`

Ok

- object
  - `sizeBytes` number, double, required
  - `text` string, required
  - `html` string, required

## Changes

- **2026-10-08** `d12d5ab961e5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gleap/apis/gleap-server/changes/engagement/emails/render-preview/post.md)

---

[API](https://skmtc.dev/gleap/apis/gleap-server.md) - [All operations](https://skmtc.dev/gleap/apis/gleap-server/llms.txt) - [OpenAPI document](https://skmtc.dev/gleap/apis/gleap-server/revisions/3b025e883cef?raw)