Create Sequence from Example

POST

api

sequences

from-example

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/from-example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "brand": "<string>",
  "sequence": "<string>",
  "brief": "<string>",
  "name": "<string>",
  "stepNumbers": [
    123
  ],
  "emailStyle": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/from-example"

payload = {
    "url": "<string>",
    "brand": "<string>",
    "sequence": "<string>",
    "brief": "<string>",
    "name": "<string>",
    "stepNumbers": [123],
    "emailStyle": "<string>"
}
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({
    url: '<string>',
    brand: '<string>',
    sequence: '<string>',
    brief: '<string>',
    name: '<string>',
    stepNumbers: [123],
    emailStyle: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/from-example', 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/from-example",
  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([
    'url' => '<string>',
    'brand' => '<string>',
    'sequence' => '<string>',
    'brief' => '<string>',
    'name' => '<string>',
    'stepNumbers' => [
        123
    ],
    'emailStyle' => '<string>'
  ]),
  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/from-example"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\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/from-example")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/from-example")

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  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\n}"

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

{
  "success": true,
  "sequence": {
    "id": "seq_3kLm9",
    "name": "Onboarding sequence",
    "status": "draft",
    "trigger": "trigger_list",
    "triggerDescription": "When someone signs up",
    "emailCount": 2,
    "enrichmentStatus": "processing",
    "steps": [
      { "stepNumber": 1, "title": "Welcome", "delayMs": 0, "originalDay": 0 },
      { "stepNumber": 2, "title": "Feature tip", "delayMs": 432000000, "originalDay": 5 }
    ]
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding",
    "omittedEmailCount": 1,
    "stepNumbers": [1, 3]
  },
  "message": "Draft sequence created with the example's trigger and timing. AI is writing each email in your brand; this typically takes 30-60 seconds. It stays a draft until you activate it."
}

{
  "error": "That url is an email example. Remix single emails with the template endpoint, or pass a sequence page url."
}

{
  "error": "Email numbers must be from 1 to 3; 5 is not one."
}

{
  "error": "Invalid API key"
}

{
  "error": "That gallery sequence was not found. It may have been removed.",
  "code": "EXAMPLE_NOT_FOUND"
}

{
  "error": "Failed to remix the example"
}

Clone a public sequence from the Sequenzy email gallery into a draft sequence for your company, the same as Clone this sequence in the dashboard. The draft keeps the example’s trigger family and send timing, up to 12 emails: the first 12, or the ones you choose with stepNumbers. AI then writes every email in your brand in the background, usually within 30 to 60 seconds. Poll Get Sequence until enrichmentStatus is complete; it reports pending until the first email is written, then in_progress. The sequence sends nothing until you enable it. Every successful call creates another sequence, so do not retry after a success. Requires the sequences:write scope.

Triggers and timing

Example sequence	Starts when	Stops early
Onboarding	A contact is added (`contact_added`)	No
Abandoned cart	`ecommerce.cart_abandoned` is received	On `ecommerce.order_placed`
Post-purchase	`ecommerce.order_placed` is received	No
Re-engagement	The `inactive` tag is added	When the tag is removed

Waits follow the real gaps between the example’s emails, and every email you clone keeps its original timing from the trigger, even when you leave out the ones before it: gaps under a day stay in hours, with at least one hour between emails, and longer gaps round to whole days. Onboarding waits for the day the first email arrived after signup. The other types start at their trigger: cart recovery waits one hour before its first email, and post-purchase and re-engagement send their first email right away. You can change the trigger and waits in the builder before enabling.

Request

Identify the example with url, or with brand and sequence. Sending both returns 400.

string

Gallery sequence page URL, such as https://sequenzy.com/email-examples/brands/linear/sequences/onboarding. An email URL returns 400.

string

Gallery brand slug. Use with sequence.

string

Gallery sequence slug, from /sequences/{sequence}. Use with brand.

string

Optional direction applied to every email, up to 1000 characters. It takes priority over the example.

string

Sequence name, up to 200 characters. Defaults to the sequence type, such as “Onboarding sequence”.

integer[]

Which of the example’s emails to clone, as 1-based positions in the gallery sequence (its Email 1, Email 2 and so on). These are positions in the example, not the stepNumber of the created sequence’s steps. Duplicates are ignored and order does not matter. Defaults to the first 12. An empty list, more than 12 distinct positions, or a position outside the sequence returns 400. More than 100 entries, or entries that are not integers, fail validation with 422.

string

visual or plain. Defaults to your company’s email style preference.

curl -X POST "https://api.sequenzy.com/api/v1/sequences/from-example" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brand": "linear",
    "sequence": "onboarding",
    "brief": "Push new users to invite a teammate",
    "stepNumbers": [1, 3]
  }'

Response

object

The draft: id, name, status (draft), trigger, triggerDescription, eventName or tagName when the trigger uses one, stopCondition (the exit rule the sequence was created with, when it has one), emailCount, enrichmentStatus (processing, or not_queued when writing could not start) and steps. Each step has stepNumber, title, delayMs (the wait before it) and originalDay.

object

The gallery sequence: brand, name, url, omittedEmailCount (the example’s emails that were not cloned, because you left them out of stepNumbers or they are beyond the 12-step limit) and stepNumbers (the positions of the cloned emails in the example, ascending).

{
  "success": true,
  "sequence": {
    "id": "seq_3kLm9",
    "name": "Onboarding sequence",
    "status": "draft",
    "trigger": "trigger_list",
    "triggerDescription": "When someone signs up",
    "emailCount": 2,
    "enrichmentStatus": "processing",
    "steps": [
      { "stepNumber": 1, "title": "Welcome", "delayMs": 0, "originalDay": 0 },
      { "stepNumber": 2, "title": "Feature tip", "delayMs": 432000000, "originalDay": 5 }
    ]
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding",
    "omittedEmailCount": 1,
    "stepNumbers": [1, 3]
  },
  "message": "Draft sequence created with the example's trigger and timing. AI is writing each email in your brand; this typically takes 30-60 seconds. It stays a draft until you activate it."
}

{
  "error": "That url is an email example. Remix single emails with the template endpoint, or pass a sequence page url."
}

{
  "error": "Email numbers must be from 1 to 3; 5 is not one."
}

{
  "error": "Invalid API key"
}

{
  "error": "That gallery sequence was not found. It may have been removed.",
  "code": "EXAMPLE_NOT_FOUND"
}

{
  "error": "Failed to remix the example"
}

A 404 with code EMAIL_GALLERY_UNAVAILABLE means the email gallery is not available yet. A 422 means a field failed validation, such as a brief over 1000 characters or an unknown emailStyle. If the draft is created but writing its emails cannot start, the response still succeeds, with enrichmentStatus: "not_queued" and a warnings entry. Open the sequence in the dashboard to write the emails instead of calling this endpoint again, which would create a second sequence.

Create Sequence from Example

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/from-example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "brand": "<string>",
  "sequence": "<string>",
  "brief": "<string>",
  "name": "<string>",
  "stepNumbers": [
    123
  ],
  "emailStyle": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/from-example"

payload = {
    "url": "<string>",
    "brand": "<string>",
    "sequence": "<string>",
    "brief": "<string>",
    "name": "<string>",
    "stepNumbers": [123],
    "emailStyle": "<string>"
}
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({
    url: '<string>',
    brand: '<string>',
    sequence: '<string>',
    brief: '<string>',
    name: '<string>',
    stepNumbers: [123],
    emailStyle: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/from-example', 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/from-example",
  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([
    'url' => '<string>',
    'brand' => '<string>',
    'sequence' => '<string>',
    'brief' => '<string>',
    'name' => '<string>',
    'stepNumbers' => [
        123
    ],
    'emailStyle' => '<string>'
  ]),
  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/from-example"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\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/from-example")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/from-example")

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  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"name\": \"<string>\",\n  \"stepNumbers\": [\n    123\n  ],\n  \"emailStyle\": \"<string>\"\n}"

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

{
  "success": true,
  "sequence": {
    "id": "seq_3kLm9",
    "name": "Onboarding sequence",
    "status": "draft",
    "trigger": "trigger_list",
    "triggerDescription": "When someone signs up",
    "emailCount": 2,
    "enrichmentStatus": "processing",
    "steps": [
      { "stepNumber": 1, "title": "Welcome", "delayMs": 0, "originalDay": 0 },
      { "stepNumber": 2, "title": "Feature tip", "delayMs": 432000000, "originalDay": 5 }
    ]
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding",
    "omittedEmailCount": 1,
    "stepNumbers": [1, 3]
  },
  "message": "Draft sequence created with the example's trigger and timing. AI is writing each email in your brand; this typically takes 30-60 seconds. It stays a draft until you activate it."
}

{
  "error": "That url is an email example. Remix single emails with the template endpoint, or pass a sequence page url."
}

{
  "error": "Email numbers must be from 1 to 3; 5 is not one."
}

{
  "error": "Invalid API key"
}

{
  "error": "That gallery sequence was not found. It may have been removed.",
  "code": "EXAMPLE_NOT_FOUND"
}

{
  "error": "Failed to remix the example"
}

​Triggers and timing

​Request

​Response

Triggers and timing

Request

Response