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.

Body

application/json
to
string
required

Recipient email address for the preview.

Example:

"rep@acme.com"

subject
string

Email subject line.

Example:

"Preview - Quick question"

body
string

Email body content (HTML or plain text) to preview.

Example:

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

templateId
integer

ID of an email template to render in the preview.

Example:

678

from
string

Sender email address. Must match a connected email account on the user when provided.

Example:

"rep@acme.com"

Response

Preview email sent

success
boolean
Example:

true