Skip to main content
POST
Render an email preview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project
string
required

Body

application/json
emailStyle
string
required
subject
any
preheader
any
message
any

TipTap document, or { localized: { <lang>: document } }.

sender

A teammate id, or { id?, customSenderName? }. Defaults to the current user.

lang
string
brand
any

Unsaved emailBrand values from the brand settings page.

emailCategory
enum<string>

Conversational emails show no unsubscribe line. Defaults to marketing (a newsletter).

Available options:
conversational,
marketing

Response

200 - application/json

Ok

sizeBytes
number<double>
required
text
string
required
html
string
required