GET

api

sequences

{sequenceId}

simulate

Simulate Sequence

curl --request GET \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate', 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}/simulate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "Trial upgrade",
  "status": "draft",
  "sendsMail": false,
  "enrollment": {
    "triggerType": "tag_added",
    "summary": "Anyone who gets the \"trial\" tag from now on goes through this sequence.",
    "note": "The 2 people who already have the tag won't be enrolled automatically - you can enroll them manually later.",
    "autoEnrollOnActivateCount": 0,
    "autoEnrollTiming": "on_future_match",
    "currentlyMatchingCount": 2,
    "currentlyMatchingEnrollsAutomatically": false,
    "currentlyMatchingSample": [
      { "id": "sub_1", "email": "maya@example.com", "name": "Maya" }
    ],
    "error": null
  },
  "readiness": {
    "ready": true,
    "errors": [],
    "warnings": []
  },
  "path": null
}

Simulate Sequence

Dry-run a sequence. Nothing is sent, no one is enrolled, and tags, lists, and discounts are not written. Activating a sequence does not enroll anyone automatically. Without a subscriber this reports who currently matches and whether the sequence is ready (existing list, tag, and segment matches can still be enrolled by hand). Pass subscriberId or email to also walk that stored contact through the graph and see which branch they take. Use that to check cases like “would a paid user get the upgrade email?” Call this before Enable Sequence.

sendsMail is always false. To send one saved email step to a reviewer, use Send Sequence Step Test.

This endpoint always requires both sequences:read and subscribers:read because aggregate results include contact samples, even when no subscriber is selected for a path preview.

Request

string

required

Sequence ID.

string

Optional stored subscriber to walk through the graph. Do not pass with email.

string

Optional stored subscriber email to walk through the graph. Do not pass with subscriberId.

integer

How many currently matching contacts to include in the sample. Defaults to 10, maximum 25.

curl "https://api.sequenzy.com/api/v1/sequences/seq_abc123/simulate" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://api.sequenzy.com/api/v1/sequences/seq_abc123/simulate?email=maya@example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

boolean

Always false.

string

Plain-language description of who enrolls after activation.

boolean

Whether an exact current-match count is available. This is false for frequency and inactivity triggers, whose matches are evaluated by the hourly worker.

number

Always 0. Activating a sequence does not enroll anyone.

number | null

Contacts who match the trigger right now and are not already in the sequence. These people are not auto-enrolled. null when currentlyMatchingAvailable is false.

boolean

false when activation blockers are present (missing trigger, unattached email, disconnected discount provider, and similar).

object

Walked graph for the optional stored subscriber, or null when none was passed. Each step may include an outcome with verdict (passed, failed, or unknown) and assumed when the branch could not be known statically.

number

Email and A/B-test steps traversed by the selected path, whether or not the subscriber can currently receive them.

number

Traversed email steps deliverable for the subscriber’s current email and subscription status. Transactional steps remain deliverable to unsubscribed contacts; bounced and email-less contacts have no deliverable emails.

Responses

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "Trial upgrade",
  "status": "draft",
  "sendsMail": false,
  "enrollment": {
    "triggerType": "tag_added",
    "summary": "Anyone who gets the \"trial\" tag from now on goes through this sequence.",
    "note": "The 2 people who already have the tag won't be enrolled automatically - you can enroll them manually later.",
    "autoEnrollOnActivateCount": 0,
    "autoEnrollTiming": "on_future_match",
    "currentlyMatchingCount": 2,
    "currentlyMatchingEnrollsAutomatically": false,
    "currentlyMatchingSample": [
      { "id": "sub_1", "email": "maya@example.com", "name": "Maya" }
    ],
    "error": null
  },
  "readiness": {
    "ready": true,
    "errors": [],
    "warnings": []
  },
  "path": null
}

Simulate Sequence

curl --request GET \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate', 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}/simulate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "Trial upgrade",
  "status": "draft",
  "sendsMail": false,
  "enrollment": {
    "triggerType": "tag_added",
    "summary": "Anyone who gets the \"trial\" tag from now on goes through this sequence.",
    "note": "The 2 people who already have the tag won't be enrolled automatically - you can enroll them manually later.",
    "autoEnrollOnActivateCount": 0,
    "autoEnrollTiming": "on_future_match",
    "currentlyMatchingCount": 2,
    "currentlyMatchingEnrollsAutomatically": false,
    "currentlyMatchingSample": [
      { "id": "sub_1", "email": "maya@example.com", "name": "Maya" }
    ],
    "error": null
  },
  "readiness": {
    "ready": true,
    "errors": [],
    "warnings": []
  },
  "path": null
}

​Simulate Sequence

​Request

​Response fields

​Responses

Simulate Sequence

Request

Response fields

Responses