Preview a template

POST

/templates/preview

const url = 'https://mail.teamander.com/v1/templates/preview';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"mjml_source":"<mjml><mj-body><mj-section><mj-column><mj-text>Hi {{name}}</mj-text></mj-column></mj-section></mj-body></mjml>","subject_template":"Welcome, {{name}}!","data":{"name":"Jane"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://mail.teamander.com/v1/templates/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mjml_source": "<mjml><mj-body><mj-section><mj-column><mj-text>Hi {{name}}</mj-text></mj-column></mj-section></mj-body></mjml>", "subject_template": "Welcome, {{name}}!", "data": { "name": "Jane" } }'

Compiles MJML and interpolates data without saving anything. MJML and Handlebars problems come back in errors rather than as a failed request, so a partially written template still renders.

Authorizations

bearerAuth

Request Body

application/json

object

mjml_source

string

design_json

object

schema_version

required

integer

>= 1 <= 1

theme

object

backgroundColor

required

string

<= 64 characters

contentBackgroundColor

required

string

<= 64 characters

fontFamily

required

string

<= 200 characters

linkColor

required

string

<= 64 characters

width

required

string

<= 16 characters

blocks

required

Array

<= 200 items

One of:

object

required

string

>= 1 characters <= 64 characters

type

required

string

Allowed values: heading

text

required

string

<= 500 characters

level

required

Any of:

number

Allowed values: 1

align

required

string

Allowed values: left center right

color

string

<= 64 characters

html

string

subject_template

string

text_body

string

data

object

key

additional properties

nullable

Example

{
  "mjml_source": "<mjml><mj-body><mj-section><mj-column><mj-text>Hi {{name}}</mj-text></mj-column></mj-section></mj-body></mjml>",
  "subject_template": "Welcome, {{name}}!",
  "data": {
    "name": "Jane"
  }
}

Responses

200

Rendered preview

application/json

object

html

required

string

subject

required

string

text

required

string

mjml_source

required

string

errors

required

Array<string>

variables

required

object

key

additional properties

string

Example

{
  "html": "<!doctype html><html>…</html>",
  "subject": "Welcome, Jane!",
  "text": "Hi Jane",
  "mjml_source": "<mjml><mj-body>…</mj-body></mjml>",
  "errors": [],
  "variables": {
    "name": "string"
  }
}

400

Validation failed

application/json

object

error

required

string

details

object

key

additional properties

nullable

Example

{
  "error": "Validation failed",
  "details": {}
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}