Skip to main content
POST
Render the email editor canvas

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

Body of render-canvas: the preview body without the message, plus the editor's content selector.

emailStyle
string
required
root
string
required

CSS selector of the editor's content element, e.g. #email-canvas .ProseMirror.

sender

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

lang
string
subject
any
preheader
any
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

slot
string
required
css
string
required
html
string
required