Preview a rendered template

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "contact": "6650d0a1b2c3d4e5f6a7b8c1"
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "contact": "6650d0a1b2c3d4e5f6a7b8c1"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: '507f1f77bcf86cd799439011', contact: '6650d0a1b2c3d4e5f6a7b8c1'})
};

fetch('https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview', 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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview",
  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([
    'user_id' => '507f1f77bcf86cd799439011',
    'contact' => '6650d0a1b2c3d4e5f6a7b8c1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}"

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

{
  "subject": "Dana, the Q3 logistics numbers",
  "body_html": "<p>Hi Dana,</p><p>Following up on my call about Acme Logistics. Worth 15 minutes next week?</p>",
  "missing_fields": [],
  "unknown": []
}

{
  "message": "Invalid ObjectId",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "The acting user is not an active member of this team",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Contact not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

Templates

Preview a rendered template

Renders the template’s subject and body for one contact, as they would get it, without sending or changing anything. Name a contact on your team to render for that person. Without one, a sample person and company are used: Jordan Rivera, VP of Operations at Northwind Logistics, with no custom fields. sender.* variables read the profile of the user_id member.

Returns { subject, body_html, missing_fields, unknown }. missing_fields lists the variables that were empty with no fallback, which render blank: the gaps a real send would have (in a preview, if_empty is not applied). unknown lists the tokens that are not variables, left as written in the output (except a custom.<field> your team does not have, which renders blank and is also listed in missing_fields), in the same shape as the 400 a save answers with, so a template saved before the check shows what its next edit to the subject or body must fix. It can list more than a save refuses: the preview does not search your contacts and companies for a custom.<field> your team has no field definition for, and a save does. Any team member may preview any template. A POST because the contact travels in the body; safe to retry. Counts toward the Sequencer writes rate limit, because it is a POST.

POST

sequencer

templates

{id}

preview

Preview a rendered template

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "contact": "6650d0a1b2c3d4e5f6a7b8c1"
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "contact": "6650d0a1b2c3d4e5f6a7b8c1"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: '507f1f77bcf86cd799439011', contact: '6650d0a1b2c3d4e5f6a7b8c1'})
};

fetch('https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview', 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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview",
  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([
    'user_id' => '507f1f77bcf86cd799439011',
    'contact' => '6650d0a1b2c3d4e5f6a7b8c1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/templates/{id}/preview")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"contact\": \"6650d0a1b2c3d4e5f6a7b8c1\"\n}"

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

{
  "subject": "Dana, the Q3 logistics numbers",
  "body_html": "<p>Hi Dana,</p><p>Following up on my call about Acme Logistics. Worth 15 minutes next week?</p>",
  "missing_fields": [],
  "unknown": []
}

{
  "message": "Invalid ObjectId",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "The acting user is not an active member of this team",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Contact not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

Renders the template’s subject and body for one contact, exactly as a send would, without sending or changing anything. It is a POST only because the contact travels in the body, so a retry is safe and it takes no Idempotency-Key.

Example

curl -X POST https://client-api.salesfinity.co/v2/sequencer/templates/6650c2b7a9b8c7d6e5f40456/preview \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -d '{ "user_id": "507f1f77bcf86cd799439011", "contact": "6650d0a1b2c3d4e5f6a7b8c1" }'

{
  "subject": "Dana, the Q3 logistics numbers",
  "body_html": "<p>Hi Dana,</p><p>Following up on my call about Acme Logistics. Worth 15 minutes next week?</p>",
  "missing_fields": [],
  "unknown": []
}

Things to know

Without contact, the template is rendered for a sample person and company: Jordan Rivera, VP of Operations at Northwind Logistics, with no custom fields. Every {{custom.<field>}} variable therefore comes back in missing_fields.
sender.* variables read the profile of the user_id member, as a send reads the rep who owns the enrollment.
missing_fields lists the variables that were empty for the contact and had no fallback. They render blank here: the gaps a real send to that person would have. A preview does not apply if_empty, so it never holds anything.
unknown lists every token that is not a variable, in the same shape as the unknown_variables error a save returns. Those tokens stay in subject and body_html exactly as written, except a custom.<field> your team does not have, which renders blank and is also listed in missing_fields. A template saved before the check can still hold one: until it is fixed, each email from it is held for the rep instead of sent.
unknown can list more than a save refuses. For a custom.<field> your team has no field definition for, a save searches your contacts and companies and accepts it when one carries the field; the preview does not search.
Any team member can preview any template. It counts toward the Sequencer writes rate limit, because it is a POST.

Authorizations

x-api-key

string

header

required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

string

required

24-character template id.

Body

application/json

user_id

string

required

The team member this call acts as. Must be an active member of the team the API key belongs to. A 24-character hexadecimal ID.

Example:

"507f1f77bcf86cd799439011"

contact

string

A contact on your team to render for (404 if not found). Without it, a sample person and company are used: Jordan Rivera, VP of Operations at Northwind Logistics, with no custom fields. A 24-character hexadecimal ID.

Response

The rendered subject and body.

subject

string

required

The rendered subject.

body_html

string

required

The rendered HTML body. Substituted values are HTML-escaped.

missing_fields

string[]

required

Variables, as written in the template, that were empty for this contact and had no fallback. They render blank.

unknown

object[]

required

Tokens that are not variables, left as written in subject and body_html, in the same shape as the 400 a save answers with. It can list a custom.<field> that a save accepts, because only a save searches your records for it. Empty when every token is a variable.

Show child attributes

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Preview a rendered template

Example

Things to know

Authorizations

Path Parameters

Body

Response

​Example

​Things to know

Authorizations

Path Parameters

Body

Response

Example

Things to know