GET

api

email-blocks

List Email Block Types

curl --request GET \
  --url https://api.sequenzy.com/api/v1/email-blocks \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sequenzy.com/api/v1/email-blocks', 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-blocks",
  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/email-blocks"

	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/email-blocks")

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,
  "blockTypes": [
    {
      "type": "list",
      "creatable": true,
      "required": ["variant", "items"],
      "optional": ["id", "color", "styles", "conditions"],
      "fields": [
        {
          "name": "variant",
          "required": true,
          "type": "enum",
          "values": ["bullet", "numbered", "checklist"]
        },
        {
          "name": "items",
          "required": true,
          "type": "array",
          "itemFields": [
            { "name": "id", "required": false, "type": "string" },
            { "name": "content", "required": true, "type": "string" },
            { "name": "color", "required": false, "type": "string" }
          ]
        }
      ],
      "example": {
        "type": "list",
        "variant": "bullet",
        "items": [{ "content": "First point" }, { "content": "Second point" }]
      },
      "notes": ["Variants: \"bullet\", \"numbered\", or \"checklist\"."]
    }
  ],
  "conditionFields": [
    {
      "field": "tag",
      "label": "Tag",
      "operators": ["contains", "not_contains", "is_empty", "is_not_empty"],
      "valueFormat": "One tag name, such as \"extended\".",
      "serverEvaluated": true,
      "previewSupport": "inline_tags_or_stored_subscriber",
      "example": {
        "id": "c1",
        "field": "tag",
        "operator": "contains",
        "value": "extended"
      }
    }
  ]
}

{
  "success": false,
  "error": "Invalid API key"
}

List Email Block Types

You can list every block type accepted by the blocks array on campaigns, sequence email steps, templates, transactional emails, and email components. Each entry names the required and optional fields, the allowed values of every enum field, and the shape of nested item arrays and nested objects. This reference is derived from the same schemas that validate a write, so it cannot drift from what those endpoints accept. The MCP tool get_email_block_schema and the sequenzy://email-blocks resource return the same payload; if the tool is missing from a client’s tool list, enable it on the Sequenzy connector or call this endpoint instead of inferring fields from live HTML.

Request

string

Pass true to hide structural block types the editor manages for you, such as group, conditional-group, and footer.

curl "https://api.sequenzy.com/api/v1/email-blocks?creatableOnly=true" \
  -H "Authorization: Bearer API_KEY"

Responses

{
  "success": true,
  "blockTypes": [
    {
      "type": "list",
      "creatable": true,
      "required": ["variant", "items"],
      "optional": ["id", "color", "styles", "conditions"],
      "fields": [
        {
          "name": "variant",
          "required": true,
          "type": "enum",
          "values": ["bullet", "numbered", "checklist"]
        },
        {
          "name": "items",
          "required": true,
          "type": "array",
          "itemFields": [
            { "name": "id", "required": false, "type": "string" },
            { "name": "content", "required": true, "type": "string" },
            { "name": "color", "required": false, "type": "string" }
          ]
        }
      ],
      "example": {
        "type": "list",
        "variant": "bullet",
        "items": [{ "content": "First point" }, { "content": "Second point" }]
      },
      "notes": ["Variants: \"bullet\", \"numbered\", or \"checklist\"."]
    }
  ],
  "conditionFields": [
    {
      "field": "tag",
      "label": "Tag",
      "operators": ["contains", "not_contains", "is_empty", "is_not_empty"],
      "valueFormat": "One tag name, such as \"extended\".",
      "serverEvaluated": true,
      "previewSupport": "inline_tags_or_stored_subscriber",
      "example": {
        "id": "c1",
        "field": "tag",
        "operator": "contains",
        "value": "extended"
      }
    }
  ]
}

{
  "success": false,
  "error": "Invalid API key"
}

Authoring notes

Lists are their own block type rather than a text variant. A text block accepts only variant: "paragraph", "lead", or "html", and never accepts items.

{ "type": "list", "variant": "numbered", "items": [{ "content": "First" }] }
{ "type": "steps", "variant": "numbered", "items": [{ "title": "Step one", "description": "What happens" }, { "title": "Step two", "description": "What happens next" }] }

Use list for a plain numbered or bulleted list, and steps for a visual numbered walkthrough. List items carry content; steps items carry title and an optional description.

Block conditions

Every block takes a conditions array that hides it unless the contact matches, and conditional-group wraps an if/else pair around the same filters. Inside a block reference, field and operator are two flat enums that pool every field’s operators together - the validator narrows them against each other, so { "field": "tag", "operator": "is" } parses as an enum member and is then rejected. conditionFields is that narrowing, spelled out. This endpoint always returns it; a single-type lookup returns it for conditional-group or with ?conditionFields=true, and otherwise returns a conditionFieldsHint string in its place:

{
  "field": "tag",
  "label": "Tag",
  "operators": ["contains", "not_contains", "is_empty", "is_not_empty"],
  "valueFormat": "One tag name, such as \"extended\". A comma-separated list matches any of them for `contains`, and none of them for `not_contains`.",
  "serverEvaluated": true,
  "previewSupport": "inline_tags_or_stored_subscriber",
  "example": {
    "id": "c1",
    "field": "tag",
    "operator": "contains",
    "value": "extended"
  }
}

serverEvaluated marks the fields read from stored subscriber state rather than from the merge data of the send, and previewSupport says what a render needs before it can evaluate one:

any_contact - resolved from merge data, so any contact previews it.
inline_tags_or_stored_subscriber - tag, which an inline contact can state for itself via subscriber.tags.
stored_subscriber - needs subscriberId; nothing inline stands in for it.

A condition a render cannot evaluate is not an error: it renders as false and is listed in that render’s unevaluatedConditions.

List Email Block Types

curl --request GET \
  --url https://api.sequenzy.com/api/v1/email-blocks \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sequenzy.com/api/v1/email-blocks', 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-blocks",
  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/email-blocks"

	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/email-blocks")

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,
  "blockTypes": [
    {
      "type": "list",
      "creatable": true,
      "required": ["variant", "items"],
      "optional": ["id", "color", "styles", "conditions"],
      "fields": [
        {
          "name": "variant",
          "required": true,
          "type": "enum",
          "values": ["bullet", "numbered", "checklist"]
        },
        {
          "name": "items",
          "required": true,
          "type": "array",
          "itemFields": [
            { "name": "id", "required": false, "type": "string" },
            { "name": "content", "required": true, "type": "string" },
            { "name": "color", "required": false, "type": "string" }
          ]
        }
      ],
      "example": {
        "type": "list",
        "variant": "bullet",
        "items": [{ "content": "First point" }, { "content": "Second point" }]
      },
      "notes": ["Variants: \"bullet\", \"numbered\", or \"checklist\"."]
    }
  ],
  "conditionFields": [
    {
      "field": "tag",
      "label": "Tag",
      "operators": ["contains", "not_contains", "is_empty", "is_not_empty"],
      "valueFormat": "One tag name, such as \"extended\".",
      "serverEvaluated": true,
      "previewSupport": "inline_tags_or_stored_subscriber",
      "example": {
        "id": "c1",
        "field": "tag",
        "operator": "contains",
        "value": "extended"
      }
    }
  ]
}

{
  "success": false,
  "error": "Invalid API key"
}

​List Email Block Types

​Request

​Responses

​Authoring notes

​Block conditions

​Related

List Email Block Types

Request

Responses

Authoring notes

Block conditions

Related