Email templates

Update email template

Update an email template: rename, change the subject or senders, replace its content, or publish/unpublish it (status). Content is re-rendered server-side. Sending html to a block template converts it to an HTML template, one way — an HTML template cannot take a document again. A PUBLISHED template is live: journeys that send it use the change from their next send, so any update to one requires confirm: true (call without it first to see the refusal). Omitted fields are unchanged.

PATCH

api

email-templates

{templateId}

Update email template

curl --request PATCH \
  --url https://www.useboom.ai/api/v1/email-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "html": "<string>",
  "fromSenderId": "<string>",
  "replyToSenderId": "<string>",
  "confirm": false
}
'

import requests

url = "https://www.useboom.ai/api/v1/email-templates/{templateId}"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "html": "<string>",
    "fromSenderId": "<string>",
    "replyToSenderId": "<string>",
    "confirm": False
}
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({
    name: '<string>',
    subject: '<string>',
    html: '<string>',
    fromSenderId: '<string>',
    replyToSenderId: '<string>',
    confirm: false
  })
};

fetch('https://www.useboom.ai/api/v1/email-templates/{templateId}', 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://www.useboom.ai/api/v1/email-templates/{templateId}",
  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([
    'name' => '<string>',
    'subject' => '<string>',
    'html' => '<string>',
    'fromSenderId' => '<string>',
    'replyToSenderId' => '<string>',
    'confirm' => false
  ]),
  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://www.useboom.ai/api/v1/email-templates/{templateId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\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://www.useboom.ai/api/v1/email-templates/{templateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.useboom.ai/api/v1/email-templates/{templateId}")

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  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\n}"

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

{
  "template": {
    "id": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "status": "DRAFT",
    "authoringMode": "BLOCKS",
    "updatedAt": "<string>",
    "variables": [
      {
        "key": "<string>",
        "path": "<string>"
      }
    ],
    "document": "<unknown>",
    "html": "<string>",
    "renderedHtml": "<string>",
    "text": "<string>",
    "fromSenderId": "<string>",
    "replyToSenderId": "<string>"
  },
  "removed": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

templateId

string

required

Email template id.

Minimum string length: 1

Body

application/json

name

string

Minimum string length: 1

subject

string

Minimum string length: 1

document

object

Block-builder content. Send exactly one of document or html.

Show child attributes

html

string

Hand-written HTML (the template becomes an HTML template). Sanitized on save — scripts, event handlers and external stylesheets are removed and listed in removed. Variables use the same {{path}} grammar.

Minimum string length: 1

fromSenderId

string | null

Sender id to send From. Must be on the verified domain (usableAsFrom in journeys_email_templates). Null/omitted = the org default.

replyToSenderId

string | null

Sender id for Reply-To. Null/omitted = the org default.

status

enum<string>

PUBLISHED makes it usable by SEND_EMAIL nodes; DRAFT withdraws it, and journeys that send it will then fail to send.

Available options:

DRAFT,

PUBLISHED

confirm

boolean

default:false

Must be true to change a template that is PUBLISHED.

Response

Success

template

object

required

Show child attributes

removed

string[]

required

What the HTML sanitizer removed. Empty for block content.

Update email template

curl --request PATCH \
  --url https://www.useboom.ai/api/v1/email-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "html": "<string>",
  "fromSenderId": "<string>",
  "replyToSenderId": "<string>",
  "confirm": false
}
'

import requests

url = "https://www.useboom.ai/api/v1/email-templates/{templateId}"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "html": "<string>",
    "fromSenderId": "<string>",
    "replyToSenderId": "<string>",
    "confirm": False
}
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({
    name: '<string>',
    subject: '<string>',
    html: '<string>',
    fromSenderId: '<string>',
    replyToSenderId: '<string>',
    confirm: false
  })
};

fetch('https://www.useboom.ai/api/v1/email-templates/{templateId}', 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://www.useboom.ai/api/v1/email-templates/{templateId}",
  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([
    'name' => '<string>',
    'subject' => '<string>',
    'html' => '<string>',
    'fromSenderId' => '<string>',
    'replyToSenderId' => '<string>',
    'confirm' => false
  ]),
  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://www.useboom.ai/api/v1/email-templates/{templateId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\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://www.useboom.ai/api/v1/email-templates/{templateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.useboom.ai/api/v1/email-templates/{templateId}")

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  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html\": \"<string>\",\n  \"fromSenderId\": \"<string>\",\n  \"replyToSenderId\": \"<string>\",\n  \"confirm\": false\n}"

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

{
  "template": {
    "id": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "status": "DRAFT",
    "authoringMode": "BLOCKS",
    "updatedAt": "<string>",
    "variables": [
      {
        "key": "<string>",
        "path": "<string>"
      }
    ],
    "document": "<unknown>",
    "html": "<string>",
    "renderedHtml": "<string>",
    "text": "<string>",
    "fromSenderId": "<string>",
    "replyToSenderId": "<string>"
  },
  "removed": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Overview

Initiatives

Journeys

Segments

WhatsApp

Email templates

Update email template

Authorizations

Path Parameters

Body

Response