Render Sequence Step HTML

POST

api

sequences

{sequenceId}

nodes

{nodeId}

render

Render Sequence Step HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriberId": "<string>",
  "subscriber": {},
  "variables": {},
  "locale": "<string>",
  "variantId": "<string>",
  "tracking": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render"

payload = {
    "subscriberId": "<string>",
    "subscriber": {},
    "variables": {},
    "locale": "<string>",
    "variantId": "<string>",
    "tracking": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscriberId: '<string>',
    subscriber: {},
    variables: {},
    locale: '<string>',
    variantId: '<string>',
    tracking: true
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscriberId' => '<string>',
    'subscriber' => [
        
    ],
    'variables' => [
        
    ],
    'locale' => '<string>',
    'variantId' => '<string>',
    'tracking' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render"

	payload := strings.NewReader("{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "html": "<!DOCTYPE html><html>...</html>",
  "subject": "Day 1: getting started",
  "previewText": "Your first steps",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "unresolvedMergeTags": [{ "tag": "discountCode", "reason": "unknown" }],
  "entity": {
    "type": "sequence_step",
    "id": "node_1",
    "variantId": null
  }
}

{
  "error": "Sequence step is not an email step"
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: subscribers:read"
}

{
  "error": "Sequence step not found"
}

Render a single sequence email step to the exact email-safe HTML that would be sent. Use this to show a visual preview of a step inside your own dashboard or email builder. The render applies everything the send path applies: your email theme and font, company branding and footer, localization, block visibility conditions, product recommendation blocks, and merge tags.

This endpoint is read-only. It requires the sequences:read scope and never sends or enrolls anyone. It uses POST only so personalization input can travel in a request body.

Request

string

required

Sequence ID.

string

required

Email step node ID. Get it from Get Sequence.

string

Personalize as this stored subscriber. Use this or subscriber, not both. Because the rendered HTML then carries that subscriber’s details, this field also requires the subscribers:read scope.

object

Personalize as an ad-hoc contact that does not need to exist in your account. Accepts email (required), firstName, lastName, and customAttributes. Use this or subscriberId, not both.

object

Extra merge variables layered over the contact’s attributes.

string

Force a localization locale instead of deriving it from the contact.

string

Render a specific A/B test variant. Required when the step is an A/B test step.

boolean

default:"false"

Apply your company’s auto-UTM link decoration, as a real send would. Defaults to false so the preview shows your own clean URLs.

curl -X POST "https://api.sequenzy.com/api/v1/sequences/seq_abc123/nodes/node_1/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "subscriberId": "sub_abc123" }'

Discount codes

When the step sits downstream of a create-discount step, {{discount.code}} and the other {{discount.*}} tags resolve against that step’s real configuration - percentage or amount, currency, expiry - with a placeholder TEST-CODE in place of the code itself. Real codes are minted per enrollment, so a preview has none to show, and this lets you check the copy before anyone is enrolled. If the step can be reached by paths that do not all run the same discount step, the preview leaves the tags empty. A real send fills them from whatever discount that recipient’s own run created, so recipients who took a path through the discount step still get a code - the preview has no way to know which path a recipient took, so it declines to guess rather than showing a code the email may not have.

Checking merge tags

An email never shows a raw {{TAG}} to a recipient, so a tag that does not exist and a tag that is simply blank for this contact both render as an empty string. unresolvedMergeTags tells them apart:

"reason": "unknown" - nothing provides that name, so it will be empty for every recipient. Usually a typo, or a tag carried over from another platform.
"reason": "no_value" - the name is recognized but has no value for this contact.

A name is only called unknown when the render had a source to check it against. Without the contact’s attributes nothing is checkable at all - a bare {{plan}} reads the same attribute map as {{subscriber.plan}} - so pass a stored subscriberId, or an inline subscriber that includes customAttributes. Beyond that, {{event.*}} needs sample event properties in variables, since a real send fills those from the enrolling event, and {{recommendedProducts.*}} needs a stored subscriberId the catalog has something to recommend for. Without those, the tags come back as no_value rather than being reported as typos. An optional attribute that this contact happens not to have set is kept out of unknown by checking the names other contacts in the account carry, which is subscriber data: that check needs the subscribers:read scope, so a key without it may report such a name as unknown. {{discount.*}} is checkable only when every path into the step runs the same discount step. An empty array means every tag in the email resolved.

What is not in the HTML

Per-send click-redirect wrapping, the open tracking pixel, and unsubscribe click tracking are applied at send time against a real email send record, so they are never present in the returned HTML. The tracking flag controls auto-UTM decoration only. Without a subscriber the footer unsubscribe link points at a placeholder URL rather than a working token.

Responses

{
  "success": true,
  "html": "<!DOCTYPE html><html>...</html>",
  "subject": "Day 1: getting started",
  "previewText": "Your first steps",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "unresolvedMergeTags": [{ "tag": "discountCode", "reason": "unknown" }],
  "entity": {
    "type": "sequence_step",
    "id": "node_1",
    "variantId": null
  }
}

{
  "error": "Sequence step is not an email step"
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: subscribers:read"
}

{
  "error": "Sequence step not found"
}

Render Sequence Step HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriberId": "<string>",
  "subscriber": {},
  "variables": {},
  "locale": "<string>",
  "variantId": "<string>",
  "tracking": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render"

payload = {
    "subscriberId": "<string>",
    "subscriber": {},
    "variables": {},
    "locale": "<string>",
    "variantId": "<string>",
    "tracking": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscriberId: '<string>',
    subscriber: {},
    variables: {},
    locale: '<string>',
    variantId: '<string>',
    tracking: true
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscriberId' => '<string>',
    'subscriber' => [
        
    ],
    'variables' => [
        
    ],
    'locale' => '<string>',
    'variantId' => '<string>',
    'tracking' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render"

	payload := strings.NewReader("{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/nodes/{nodeId}/render")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscriberId\": \"<string>\",\n  \"subscriber\": {},\n  \"variables\": {},\n  \"locale\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"tracking\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "html": "<!DOCTYPE html><html>...</html>",
  "subject": "Day 1: getting started",
  "previewText": "Your first steps",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "unresolvedMergeTags": [{ "tag": "discountCode", "reason": "unknown" }],
  "entity": {
    "type": "sequence_step",
    "id": "node_1",
    "variantId": null
  }
}

{
  "error": "Sequence step is not an email step"
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: subscribers:read"
}

{
  "error": "Sequence step not found"
}

​Request

​Discount codes

​Checking merge tags

​What is not in the HTML

​Responses

Request

Discount codes

Checking merge tags

What is not in the HTML

Responses