---
title: "Preview Branded Email"
method: POST
path: "/api/v1/settings/branding/preview-email"
tags: ["settings"]
---

# Preview Branded Email

`POST /api/v1/settings/branding/preview-email`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/settings/branding/preview-email`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

Render the real invoice email template with sample invoice data and the
posted (possibly unsaved) branding — for the design editor's live preview.
Plan-gated like every other branding read path (resolver invariant).

## Request body

- EmailPreviewRequest
  - `logo_url` string, nullable
  - `accent_color` string, nullable
  - `background_color` string, nullable
  - `show_powered_by` boolean, nullable
  - `lang` string

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)