Preview a rendered template

Request body

• subjectstring

  The subject line to preview.

• htmlstring

  The HTML to preview, with {{ tags }}.

• skeleton_htmlstring

  Optional, advanced. Your own HTML with data-my-edit on the parts people may change in the dashboard. We build html from it and content.

• source_template_keystring

  Optional. Make the template from one of our ready-made designs, by the design's key. We build html from the design, your brand kit and content.

• contentobject

  For a template made from a design (source_template_key) or from skeleton_html: the text and images for each editable part, keyed by the part's name. Not used with plain html.

• layoutstring

  For a template made from a design: which version of the design, for example branded or plain. A name the design does not have falls back to its default.

• show_company_nameboolean

  For a template made from a design: show your company name at the top. Leave it out, or send null, to follow your brand kit.

• plain_textstring

  Plain text to preview. With plain: true, it is laid out exactly as a plain email is sent.

• plainboolean

  Send true to preview plain_text as a plain email, exactly as it would be sent.

• variablesobject

  Sample values for the {{ tags }}, like {"name": "Ada"}. email and organization_name are filled for you.

• brandobject

  Optional. Brand kit values to try before saving them (logo, colours, company name).

Request

curl -X POST 'https://app.mailyte.com/api/v1/email-templates/preview' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "html": "<p>Hi {{name}}</p>",
    "variables": {
      "name": "Ada"
    }
  }'

const response = await fetch('https://app.mailyte.com/api/v1/email-templates/preview', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "html": "<p>Hi {{name}}</p>",
    "variables": {
      "name": "Ada"
    }
  }),
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/email-templates/preview",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "html": "<p>Hi {{name}}</p>",
      "variables": {
        "name": "Ada"
      }
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/email-templates/preview', [
    'html' => '<p>Hi {{name}}</p>',
    'variables' => [
        'name' => 'Ada',
    ],
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-templates/preview")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "html": "<p>Hi {{name}}</p>",
  "variables": {
    "name": "Ada"
  }
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringtemplate_preview
  • subjectstring

    The subject with {{ }} variables filled in, as a real send would show it. Null when you sent no subject. "" usually means a placeholder you gave no value for.

  • htmlstring

    The HTML with {{ }} variables filled in; values are HTML-escaped here. Null when you sent no html. This endpoint previews only what you post: it does not load a saved template.

  • textstring

    The rendered plain-text body. The REQUEST field for it is plain_text, not text: this endpoint validates plain_text and drops a text key, so posting text renders nothing and returns null here.

  • variablesarray<string>

    The {{ }} placeholder names found in what you sent, whether or not you gave them values.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.