---
title: "Preview a form's welcome email"
method: POST
path: "/v1/forms/{id}/welcome-preview"
tags: ["Forms"]
---

# Preview a form's welcome email

`POST /v1/forms/{id}/welcome-preview`

## Request

- Base URL: `https://smtpfa.st/api`
- URL: `https://smtpfa.st/api/v1/forms/{id}/welcome-preview`
- Auth: HTTP bearer

Render the welcome email of a signup form for a sample contact, without sending it. Pass subject and markdown to preview unsaved changes. Not in Resend. Requires the form:read scope.

## Path parameters

- `id` string, required

## Request body

- object
  - `subject` string
  - `markdown` string
  - `sample` object
    - `email` string
    - `firstName` string
    - `lastName` string

## Response `200`

The rendered subject, HTML and text

- object

## Other responses

- `400`: Bad request - check your payload
- `401`: Invalid or missing API key
- `403`: Forbidden - domain not verified or insufficient permissions
- `404`: Resource not found
- `429`: Rate limit exceeded - retry after the period indicated in the Retry-After header
- `500`: Internal server error

---

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