---
title: "Render unsaved form settings as a complete HTML page on a sketched website."
method: POST
path: "/v1/workspaces/{workspaceId}/signup-forms/preview"
---

# Render unsaved form settings as a complete HTML page on a sketched website.

`POST /v1/workspaces/{workspaceId}/signup-forms/preview`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/signup-forms/preview`
- Auth: HTTP bearer

## Request body

- object
  - `kind` 'inline' | 'popup' | 'bar' | 'slide_in' | 'page'
  - `config` SignupFormConfig
    - `eyebrow` string
    - `headline` string
    - `body` string
    - `button_label` string
    - `email_placeholder` string
    - `name_placeholder` string
    - `fine_print` string
    - `incentive` string
    - `success_headline` string
    - `success_body` string
    - `redirect_url` string
    - `image_url` string
    - `art` 'arcs' | 'blocks' | 'horizon' | 'confetti' | 'frame' | 'bands' | 'dots'
    - `style` '' | 'brand' | 'material' | 'clarity' | 'editorial' | 'bold' | 'luxe' | 'playful' | 'plain'
    - `count_noun` string
    - `confirm_promise` string
    - `locale` string
    - `collect_name` boolean
    - `show_logo` boolean
    - `show_count` boolean
    - `exit_intent` boolean
    - `delay_seconds` integer
    - `scroll_percent` integer
    - `frequency_days` integer
    - `image` 'none' | 'photo' | 'art'
    - `layout` 'stacked' | 'split'
    - `theme` 'light' | 'dark' | 'brand' | 'auto'
    - `position` 'bottom' | 'top' | 'right' | 'left'
    - `fields` object[]
      - `key` string
      - `label` string, required
      - `type` 'text' | 'select' | 'checkbox'
      - `required` boolean
      - `placeholder` string
      - `options` string[]
  - `double_opt_in` boolean
  - `state` 'form' | 'success'

## Response `200`

Successful response.

- object
  - `data` object, required
    - `kind` 'inline' | 'popup' | 'bar' | 'slide_in' | 'page', required
    - `state` 'form' | 'success', required
    - `html` string, required

---

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