Preview Default Footer

POST

api

email-components

defaults

{slot}

preview

Preview Default Footer

curl --request POST \
  --url https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/preview"

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

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

print(response.text)

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

fetch('https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/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/email-components/defaults/{slot}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/email-components/defaults/{slot}/preview"

	req, _ := http.NewRequest("POST", 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/email-components/defaults/{slot}/preview")

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

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

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

You can preview a footer update without saving it. Send blocks (a nonempty email block array), optional name and nullable description, and required application with scopes and optional includeCustomized. An empty scope array previews only the default. The supported slot is footer.

{
  "blocks": [
    {
      "type": "footer",
      "variant": "full",
      "companyName": "Acme",
      "address": "123 Main Street"
    }
  ],
  "application": {
    "scopes": ["sequences", "campaigns"],
    "includeCustomized": false
  },
  "renderPreview": true
}

The 200 response includes success, application.token, application.counts, application.affected, and application.skipped. Each item has scope, kind, id, and name; skipped items also have reason. With renderPreview: true, renderedPreview contains footerHtml, samples with beforeHtml and afterHtml, and a preview limitation note. By default you receive up to one sample per selected category. Supply sample: { id, kind } for a particular affected email version. Personal keys require workspace admin access. Keys need emails:write, selected category write scopes, and ab_tests:write for sequences or campaigns, matching application permissions. Invalid blocks or slots return 400, invalid credentials return 401, missing permissions return 403. Malformed request shapes, such as missing required fields or invalid scope values, return 422. Unexpected rendering or database failures return 500; transient database unavailability may return 503. Apply with Set Default Email Component using identical inputs and previewToken. Preview does not modify content or send emails.

Preview Default Footer

curl --request POST \
  --url https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/preview"

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

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

print(response.text)

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

fetch('https://api.sequenzy.com/api/v1/email-components/defaults/{slot}/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/email-components/defaults/{slot}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/email-components/defaults/{slot}/preview"

	req, _ := http.NewRequest("POST", 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/email-components/defaults/{slot}/preview")

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

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

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