Preview Sequence from Example

POST

api

sequences

from-example

preview

Preview Sequence from Example

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

import requests

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

payload = {
    "url": "<string>",
    "brand": "<string>",
    "sequence": "<string>",
    "brief": "<string>",
    "website": "<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>',
    website: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/from-example/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://api.sequenzy.com/api/v1/sequences/from-example/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([
    'url' => '<string>',
    'brand' => '<string>',
    'sequence' => '<string>',
    'brief' => '<string>',
    'website' => '<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/preview"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"website\": \"<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/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"website\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"website\": \"<string>\"\n}"

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

{
  "success": true,
  "preview": {
    "brandName": "Acme",
    "website": null,
    "emails": [
      {
        "stepNumber": 1,
        "day": 0,
        "originalSubject": "Welcome to Linear",
        "subject": "Welcome to Acme",
        "previewText": "Your first project takes two minutes",
        "html": "<html>...</html>"
      }
    ],
    "remainingEmailCount": 2,
    "failedEmailCount": 0
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "emailCount": 5,
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding"
  },
  "message": "Preview only: the first emails, nothing saved. Call POST /sequences/from-example to create the draft sequence."
}

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

{
  "error": "The preview could not be written. Try again in a moment.",
  "code": "REMIX_FAILED"
}

Rewrite the first 3 emails of a public sequence from the Sequenzy email gallery and get them back without creating anything. Each email keeps the example’s layout with every word written for your brand. By default the preview is written for your company’s brand profile. Pass website to write it for another site instead, such as a prospect or a client. The emails are written in parallel. Any that could not be written this time are counted in failedEmailCount; the call fails only when none could be written. It usually takes 10 to 30 seconds. To create the sequence, call Create Sequence from Example, which writes every email again for your own brand. Requires the sequences:write scope.

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; use Preview Template from Example for one email.

string

Gallery brand slug. Use with sequence.

string

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

string

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

string

Optional site or domain, such as acme.com, to write the preview for instead of your own brand. Its registrable domain is used. A value that is not a site returns 400.

curl -X POST "https://api.sequenzy.com/api/v1/sequences/from-example/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding"
  }'

Response

object

The unsaved rewrite: brandName, website (null for your own brand), emails, remainingEmailCount (emails in the example beyond the preview) and failedEmailCount (previewed emails that could not be written this time). Each email has stepNumber (its position in the example, from 1), day, originalSubject, subject, previewText and html.

object

The gallery sequence it is modeled on: brand, name, emailCount and url.

{
  "success": true,
  "preview": {
    "brandName": "Acme",
    "website": null,
    "emails": [
      {
        "stepNumber": 1,
        "day": 0,
        "originalSubject": "Welcome to Linear",
        "subject": "Welcome to Acme",
        "previewText": "Your first project takes two minutes",
        "html": "<html>...</html>"
      }
    ],
    "remainingEmailCount": 2,
    "failedEmailCount": 0
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "emailCount": 5,
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding"
  },
  "message": "Preview only: the first emails, nothing saved. Call POST /sequences/from-example to create the draft sequence."
}

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

{
  "error": "The preview could not be written. Try again in a moment.",
  "code": "REMIX_FAILED"
}

A 400 means a missing, conflicting or invalid example reference, or a malformed website. A 404 with code EMAIL_GALLERY_UNAVAILABLE means the email gallery is not available yet. A 422 means a field failed validation.

Preview Sequence from Example

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

import requests

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

payload = {
    "url": "<string>",
    "brand": "<string>",
    "sequence": "<string>",
    "brief": "<string>",
    "website": "<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>',
    website: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/from-example/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://api.sequenzy.com/api/v1/sequences/from-example/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([
    'url' => '<string>',
    'brand' => '<string>',
    'sequence' => '<string>',
    'brief' => '<string>',
    'website' => '<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/preview"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"website\": \"<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/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"sequence\": \"<string>\",\n  \"brief\": \"<string>\",\n  \"website\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"website\": \"<string>\"\n}"

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

{
  "success": true,
  "preview": {
    "brandName": "Acme",
    "website": null,
    "emails": [
      {
        "stepNumber": 1,
        "day": 0,
        "originalSubject": "Welcome to Linear",
        "subject": "Welcome to Acme",
        "previewText": "Your first project takes two minutes",
        "html": "<html>...</html>"
      }
    ],
    "remainingEmailCount": 2,
    "failedEmailCount": 0
  },
  "example": {
    "brand": "Linear",
    "name": "Linear onboarding",
    "emailCount": 5,
    "url": "https://sequenzy.com/email-examples/brands/linear/sequences/onboarding"
  },
  "message": "Preview only: the first emails, nothing saved. Call POST /sequences/from-example to create the draft sequence."
}

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

{
  "error": "The preview could not be written. Try again in a moment.",
  "code": "REMIX_FAILED"
}

​Request

​Response

Request

Response