Design Studio emails

Render an email

Returns email-ready HTML. Use this endpoint to inspect your compiled markup.

Liquid tags are left intact—{{customer.first_name}} stays in the output as written. To evaluate liquid against real profile data instead, use Preview an email.

The render, preview, review, link, and publish endpoints share a rate limit of 5 requests per second per workspace.

get/v1/design_studio/emails/{id}/render

Path parameters

idstring uuid required

The UUID of the email. If your email has translations, this is the ID of a specific language variant.

Response

Successful response

node_idstring uuid

The UUID of the rendered email node.

node_type'EMAIL'

Always "EMAIL".

htmlstring

Full HTML with liquid tags left intact.

textstring

Plain text version of the email. Omitted unless you added a plain text version when you created the email.

languagestring

Language code if the node is a translation (for example, "es"). Omitted for default-language nodes.

ampstring

AMP HTML variant. Omitted unless you added an AMP version when you created the email.

Example response

{
  "node_id": "1a0cbb4e-09d3-402e-949e-f6732f021650",
  "node_type": "EMAIL",
  "html": "<!doctype html>\n<html lang=\"und\">...\n<p>{{customer.first_name}}, welcome!</p>\n...\n</html>",
  "text": "<html><head></head><body style=\"margin:0\"><div style=\"font-size:16px;line-height:1.5;font-family:Arial,Helvetica,sans-serif;white-space:pre-wrap;padding:10px;\">{{customer.first_name}}, welcome!</div></body></html>"
}

Changes

Changed in 1 of the 13 revisions of this API.1