Get Transactional Email

GET

api

transactional

{idOrSlug}

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

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

fetch('https://api.sequenzy.com/api/v1/transactional/{idOrSlug}', 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/transactional/{idOrSlug}",
  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/transactional/{idOrSlug}"

	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/transactional/{idOrSlug}")

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,
  "transactional": {
    "id": "txn_abc123",
    "name": "Welcome Email",
    "slug": "welcome",
    "emailId": "email_abc123",
    "labels": ["Billing"],
    "enabled": true,
    "managedBy": "dashboard",
    "subject": "Welcome, {{NAME}}",
    "previewText": "Your account is ready.",
    "emailPreset": "branded",
    "blocks": [
      {
        "id": "block_123",
        "type": "text",
        "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
        "variant": "html"
      }
    ],
    "variables": ["NAME", "COMPANY_NAME", "LOGIN_URL"],
    "email": {
      "id": "email_abc123",
      "name": "Welcome Email",
      "subject": "Welcome, {{NAME}}",
      "previewText": "Your account is ready.",
      "blocks": [
        {
          "id": "block_123",
          "type": "text",
          "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
          "variant": "html"
        }
      ]
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

{
  "success": false,
  "error": "Transactional email \"welcome\" not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Internal server error"
}

Get details of a transactional email template, including the linked email subject, preview text, body blocks, Style > Format, and available template variables.

Path Parameters

string

required

Transactional email ID or slug

curl "https://api.sequenzy.com/api/v1/transactional/welcome" \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses

{
  "success": true,
  "transactional": {
    "id": "txn_abc123",
    "name": "Welcome Email",
    "slug": "welcome",
    "emailId": "email_abc123",
    "labels": ["Billing"],
    "enabled": true,
    "managedBy": "dashboard",
    "subject": "Welcome, {{NAME}}",
    "previewText": "Your account is ready.",
    "emailPreset": "branded",
    "blocks": [
      {
        "id": "block_123",
        "type": "text",
        "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
        "variant": "html"
      }
    ],
    "variables": ["NAME", "COMPANY_NAME", "LOGIN_URL"],
    "email": {
      "id": "email_abc123",
      "name": "Welcome Email",
      "subject": "Welcome, {{NAME}}",
      "previewText": "Your account is ready.",
      "blocks": [
        {
          "id": "block_123",
          "type": "text",
          "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
          "variant": "html"
        }
      ]
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

{
  "success": false,
  "error": "Transactional email \"welcome\" not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Internal server error"
}

The variables array shows template variables extracted from the email content. Use these when sending to customize the email.

managedBy is code for emails created by sending direct content with trackAs. Their subject, previewText and blocks are a snapshot of a recent send, refreshed at most every 10 minutes, and they cannot be sent by slug.

emailPreset is the email’s Style > Format: branded (company logo and full footer) or minimal (no logo, simple footer). It is derived from the stored blocks and is reported the same way for sequence steps, campaigns, and saved templates, so you can compare chrome across emails without rendering them. It is null when the entire email is a single raw HTML block, which has no Sequenzy format.

transactional.labels contains assigned company label names, or [] when unlabelled. Insufficient API-key permissions return 403. Label support uses the existing transactional read permission; no additional label scope is required.

Get Transactional Email

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

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

fetch('https://api.sequenzy.com/api/v1/transactional/{idOrSlug}', 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/transactional/{idOrSlug}",
  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/transactional/{idOrSlug}"

	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/transactional/{idOrSlug}")

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,
  "transactional": {
    "id": "txn_abc123",
    "name": "Welcome Email",
    "slug": "welcome",
    "emailId": "email_abc123",
    "labels": ["Billing"],
    "enabled": true,
    "managedBy": "dashboard",
    "subject": "Welcome, {{NAME}}",
    "previewText": "Your account is ready.",
    "emailPreset": "branded",
    "blocks": [
      {
        "id": "block_123",
        "type": "text",
        "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
        "variant": "html"
      }
    ],
    "variables": ["NAME", "COMPANY_NAME", "LOGIN_URL"],
    "email": {
      "id": "email_abc123",
      "name": "Welcome Email",
      "subject": "Welcome, {{NAME}}",
      "previewText": "Your account is ready.",
      "blocks": [
        {
          "id": "block_123",
          "type": "text",
          "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
          "variant": "html"
        }
      ]
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

{
  "success": false,
  "error": "Transactional email \"welcome\" not found"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Internal server error"
}

​Path Parameters

​Responses

Path Parameters

Responses