Update Transactional Email

PATCH

api

transactional

{idOrSlug}

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/transactional/{idOrSlug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "labels": [
    "<string>"
  ],
  "name": "<string>",
  "enabled": true,
  "subject": "<string>",
  "previewText": {},
  "html": "<string>",
  "blocks": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/transactional/{idOrSlug}"

payload = {
    "labels": ["<string>"],
    "name": "<string>",
    "enabled": True,
    "subject": "<string>",
    "previewText": {},
    "html": "<string>",
    "blocks": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    labels: ['<string>'],
    name: '<string>',
    enabled: true,
    subject: '<string>',
    previewText: {},
    html: '<string>',
    blocks: [{}]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'labels' => [
        '<string>'
    ],
    'name' => '<string>',
    'enabled' => true,
    'subject' => '<string>',
    'previewText' => [
        
    ],
    'html' => '<string>',
    'blocks' => [
        [
                
        ]
    ]
  ]),
  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/transactional/{idOrSlug}"

	payload := strings.NewReader("{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sequenzy.com/api/v1/transactional/{idOrSlug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}"

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,
    "subject": "Welcome, {{NAME}}",
    "previewText": "Your account is ready.",
    "blocks": [
      {
        "id": "block_123",
        "type": "text",
        "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
        "variant": "html"
      }
    ],
    "variables": ["NAME", "COMPANY_NAME"],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z"
  }
}

{
  "success": false,
  "error": "Provide at least one of name, enabled, subject, previewText, html, blocks, or labels."
}

{
  "success": false,
  "error": "This transactional email is managed in code. Its content comes from each send; update name, enabled or labels instead."
}

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

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

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

Update a transactional email by ID or slug. You can update metadata like name and enabled, or replace the linked email body with html or blocks. Code-managed emails (managedBy: "code", created by sends with trackAs) accept only name, enabled and labels. Their content comes from each send, so subject, previewText, html and blocks return 400. Set enabled to false to reject further sends with that trackAs.

Path Parameters

string

required

Transactional email ID or slug

Request

string[]

Company label names, trimmed and deduplicated. Missing names are created in your company. Each name must be non-empty and at most 255 characters. Send [] to clear assignments. Omit to keep existing labels. null, blank names, and non-string entries are rejected.

string

Transactional email name

boolean

Whether this transactional email can be sent

string

Email subject line

string | null

Email preview text. Send null to clear it; omit the field to keep the current value.

string

Raw HTML body. Provide either html or blocks, not both.

array

Sequenzy email blocks. Provide either blocks or html, not both. Put block styling under styles; top-level style keys like backgroundColor, backgroundOpacity, textColor, textAlign, borderColor, borderWidth, and borderRadius are normalized into styles.

curl -X PATCH "https://api.sequenzy.com/api/v1/transactional/welcome" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Welcome, {{NAME}}",
    "html": "<p>Welcome to {{COMPANY_NAME}}</p>"
  }'

Responses

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

{
  "success": false,
  "error": "Provide at least one of name, enabled, subject, previewText, html, blocks, or labels."
}

{
  "success": false,
  "error": "This transactional email is managed in code. Its content comes from each send; update name, enabled or labels instead."
}

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

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

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

Label names appear in the response’s transactional.labels array. Invalid label names return 400; invalid label types return 422. Retrying the same label replacement does not duplicate company labels or send an email. After an uncertain update response, read the template before retrying. Label-only updates preserve email content and translations. Insufficient API-key permissions return 403. Label support uses the existing transactional write permission; no additional label scope is required.

Update Transactional Email

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/transactional/{idOrSlug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "labels": [
    "<string>"
  ],
  "name": "<string>",
  "enabled": true,
  "subject": "<string>",
  "previewText": {},
  "html": "<string>",
  "blocks": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/transactional/{idOrSlug}"

payload = {
    "labels": ["<string>"],
    "name": "<string>",
    "enabled": True,
    "subject": "<string>",
    "previewText": {},
    "html": "<string>",
    "blocks": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    labels: ['<string>'],
    name: '<string>',
    enabled: true,
    subject: '<string>',
    previewText: {},
    html: '<string>',
    blocks: [{}]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'labels' => [
        '<string>'
    ],
    'name' => '<string>',
    'enabled' => true,
    'subject' => '<string>',
    'previewText' => [
        
    ],
    'html' => '<string>',
    'blocks' => [
        [
                
        ]
    ]
  ]),
  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/transactional/{idOrSlug}"

	payload := strings.NewReader("{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sequenzy.com/api/v1/transactional/{idOrSlug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"enabled\": true,\n  \"subject\": \"<string>\",\n  \"previewText\": {},\n  \"html\": \"<string>\",\n  \"blocks\": [\n    {}\n  ]\n}"

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,
    "subject": "Welcome, {{NAME}}",
    "previewText": "Your account is ready.",
    "blocks": [
      {
        "id": "block_123",
        "type": "text",
        "content": "<p>Welcome to {{COMPANY_NAME}}</p>",
        "variant": "html"
      }
    ],
    "variables": ["NAME", "COMPANY_NAME"],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z"
  }
}

{
  "success": false,
  "error": "Provide at least one of name, enabled, subject, previewText, html, blocks, or labels."
}

{
  "success": false,
  "error": "This transactional email is managed in code. Its content comes from each send; update name, enabled or labels instead."
}

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

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

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

​Path Parameters

​Request

​Responses

Path Parameters

Request

Responses