Render Campaign HTML

POST

api

campaigns

{campaignId}

render

Render Campaign HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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": "Anna, your Pro plan is ready",
  "previewText": "Everything you unlocked this month",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "entity": {
    "type": "campaign",
    "id": "camp_abc123",
    "variantId": null
  }
}

{
  "error": "Provide either subscriberId or subscriber, not both."
}

{
  "error": "Unauthorized"
}

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

{
  "error": "Campaign not found"
}

Render a campaign to the exact email-safe HTML that would be sent. Use this to show a visual preview inside your own dashboard or email builder without duplicating Sequenzy’s rendering logic. 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 campaigns:read scope and never sends, schedules, or modifies anything. It uses POST only so personalization input can travel in a request body.

Request

string

required

Campaign ID.

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 of this campaign.

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/campaigns/camp_abc123/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriber": {
      "email": "anna@example.com",
      "firstName": "Anna"
    },
    "variables": { "plan": "Pro" },
    "tracking": false
  }'

Personalization

Without subscriberId or subscriber, the campaign renders for a sample contact and merge tags resolve to empty values. The response’s personalized field tells you which happened. Only a stored subscriber (subscriberId) can resolve subscriber-scoped content: block visibility conditions, product recommendations, and a working unsubscribe link. An inline subscriber covers name and attribute merge tags. Passing subscriberId puts that subscriber’s data into the returned HTML, so it needs the subscribers:read scope on top of campaigns:read. Rendering for a sample contact or an inline subscriber needs only campaigns:read.

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. A preview has no such record, so those are never present in the returned HTML - emitting placeholder versions would give you URLs that 404. The tracking flag therefore controls auto-UTM decoration only, which is genuinely applied at render time.

Responses

{
  "success": true,
  "html": "<!DOCTYPE html><html>...</html>",
  "subject": "Anna, your Pro plan is ready",
  "previewText": "Everything you unlocked this month",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "entity": {
    "type": "campaign",
    "id": "camp_abc123",
    "variantId": null
  }
}

{
  "error": "Provide either subscriberId or subscriber, not both."
}

{
  "error": "Unauthorized"
}

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

{
  "error": "Campaign not found"
}

Create CampaignCreate an email campaign

Render Campaign HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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/campaigns/{campaignId}/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": "Anna, your Pro plan is ready",
  "previewText": "Everything you unlocked this month",
  "locale": "en",
  "personalized": true,
  "trackingApplied": false,
  "entity": {
    "type": "campaign",
    "id": "camp_abc123",
    "variantId": null
  }
}

{
  "error": "Provide either subscriberId or subscriber, not both."
}

{
  "error": "Unauthorized"
}

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

{
  "error": "Campaign not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Render Campaign HTML

Request

Personalization

What is not in the HTML

Responses

​Request

​Personalization

​What is not in the HTML

​Responses

Request

Personalization

What is not in the HTML

Responses