Preview Email

POST

/preview/v1

Authorizations

• auth_key

Request Body ^required

object

subject

required

Email subject

string

>= 1 characters <= 70 characters

Welcome to our newsletter! No.{{no}}

body

required

Email body content

string

<= 20000 characters

# Dear {{name}},

Thank you for subscribing to our newsletter. **We're excited to share our latest updates with you.**

Best regards,
The Team

to

required

List of recipients

Array

>= 1 items <= 50 items

object

email

required

Email address

string format: email

name

Name (optional)

string | null

<= 20 characters

personalizations

List of personalization data

array | null

<= 10 items

Replace “name” with “value.” name” must be enclosed in {{}}. The “field” can be either “subject” or “content”. If not specified, “content” is used. Fields converted with “content” will be “body” “header” “footer” “buttons” “logo” “authors” and “links”.

object

name

required

String to be replaced

string

<= 50 characters

{{user_name}}

value

required

Value to replace “name”

string

<= 200 characters

John Doe

field

Field to apply personalization

string | null

Allowed values: subject content ""

content

[
  {
    "email": "[email protected]",
    "name": "John Doe",
    "personalizations": [
      {
        "name": "{{name}}",
        "value": "John"
      }
    ]
  }
]

preview

Preview text

string | null

<= 50 characters

Welcome to our newsletter! Exciting updates inside

sender

Sender name

string | null

<= 20 characters

logo

object

image

URL of the logo image

string | null format: uri

href

URL for the logo link

string | null format: uri

name

Alternative text for the logo

string | null

<= 30 characters

bg

Flag to use background color

boolean | null

align

Logo alignment

string | null

Allowed values: left center right ""

authors

List of authors

array | null

<= 10 items

object

name

Author name

string | null

<= 20 characters

image

URL of the author’s image

string | null format: uri

bio

Author’s brief biography

string | null

<= 40 characters

box

Display position of author information

string | null

Allowed values: header body footer ""

position

Detailed display position of author information

string | null

Allowed values: top bottom left right ""

theme

Theme number

integer | null

<= 7

style

Style number

integer | null

<= 4

header

Header text

string | null

<= 20000 characters

footer

Footer text

string | null

<= 20000 characters

reply_to

object

email

required

Email address

string format: email

name

Name (optional)

string | null

<= 20 characters

links

List of links

array | null

<= 4 items

You can set up links related to the content of the email. They are displayed at the bottom of the content. Some sites are displayed with special icons.

object

href

required

URL of the link

string format: uri

buttons

List of buttons

array | null

<= 6 items

Display buttons at the top or bottom of the content. External links can be set up.

object

text

required

Button text

string

<= 20 characters

href

required

URL for the button link

string format: uri

box

Display position of the button

string | null

Allowed values: header body footer ""

full

Full-width button flag

boolean | null

bg

Flag to use background color

boolean | null

defaults

Default value for string replacement

array | null

<= 10 items

Replace “name” with “value.” name” must be enclosed in {{}}. The “field” can be either “subject” or “content”. If not specified, “content” is used. Fields converted with “content” will be “body” “header” “footer” “buttons” “logo” “authors” and “links”.

object

name

required

String to be replaced

string

<= 50 characters

{{user_name}}

value

required

Value to replace “name”

string

<= 200 characters

John Doe

field

Field to apply personalization

string | null

Allowed values: subject content ""

content

dark

Dark mode flag

boolean | null

html_to_md

Converts HTML to Markdown for body, header, and footer if set to true.

boolean | null

marketing

Indicates if this is a marketing email, affecting legal compliance and user preferences.

boolean | null

Responses

200

Successful Operation

object

success

Indicates if the operation was successful

boolean

error

Error message

string | null

errors

List of validation errors

array | null

object

field

required

Name of the field where the error occurred

string

message

required

Error message

string

blocks

List of blocked email addresses

array | null

bounces

List of bounced email addresses

array | null

limit

Limit information

string |

400

Invalid input

401

Auth exception

404

User Not Found

422

Validation exception

429

Rate limits exceeded