Skip to main content
POST
Send an email preview

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Body

application/json
to
string
required

Recipient email address for the preview.

Example:

"rep@acme.com"

subject
string
required

Email subject line.

Example:

"Preview - Quick question"

body
string
required

Email body content (HTML or plain text) to preview. Templates cannot be previewed by ID; send the rendered content.

Example:

"Hi there, I wanted to reach out..."

from
string
required

Sender email address. Must match one of the caller's own connected email accounts.

Example:

"rep@acme.com"

Response

Preview email sent

success
boolean
Example:

true