curl --request PATCH \
--url https://api.statisfy.com/v1/templates/{template_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"editor": null,
"html": null,
"name": null,
"sender_email": "<string>",
"sender_name": "<string>",
"state": null,
"subject": "<string>",
"type": null
}
'import requests
url = "https://api.statisfy.com/v1/templates/{template_id}"
payload = {
"description": "<string>",
"editor": None,
"html": None,
"name": None,
"sender_email": "<string>",
"sender_name": "<string>",
"state": None,
"subject": "<string>",
"type": None
}
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({
description: '<string>',
editor: null,
html: null,
name: null,
sender_email: '<string>',
sender_name: '<string>',
state: null,
subject: '<string>',
type: null
})
};
fetch('https://api.statisfy.com/v1/templates/{template_id}', 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.statisfy.com/v1/templates/{template_id}",
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([
'description' => '<string>',
'editor' => null,
'html' => null,
'name' => null,
'sender_email' => '<string>',
'sender_name' => '<string>',
'state' => null,
'subject' => '<string>',
'type' => null
]),
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.statisfy.com/v1/templates/{template_id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\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.statisfy.com/v1/templates/{template_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/templates/{template_id}")
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 \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\n}"
response = http.request(request)
puts response.read_body{
"attachments": [
{
"filename": "<string>",
"id": "<string>",
"mime_type": "<string>",
"size_bytes": 123
}
],
"created_at": "2023-11-07T05:31:56Z",
"creator": "<string>",
"description": "<string>",
"editor": "visual",
"html": "<string>",
"id": "<string>",
"merge_tags": [
"<string>"
],
"name": "<string>",
"sender_email": "<string>",
"sender_name": "<string>",
"state": "draft",
"subject": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"used_by_campaigns": 123
}Change an email template
Changes what you send of a template: its name, type, description, subject, sender, HTML or state. Campaigns and flows read a template each time they send, draft or published, so a change goes out on their next send, as an edit in the app does (a flow email already waiting for approval keeps what it rendered). A template that is or was published must still meet what publishing needs after the change, even one that makes it a draft. The HTML of a template built in the app’s visual editor changes only with editor: html, which moves it to the HTML editor and drops its visual design (a 409 otherwise). A 409 with Retry-After means another change held the template, so nothing was written: send it again.
curl --request PATCH \
--url https://api.statisfy.com/v1/templates/{template_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"editor": null,
"html": null,
"name": null,
"sender_email": "<string>",
"sender_name": "<string>",
"state": null,
"subject": "<string>",
"type": null
}
'import requests
url = "https://api.statisfy.com/v1/templates/{template_id}"
payload = {
"description": "<string>",
"editor": None,
"html": None,
"name": None,
"sender_email": "<string>",
"sender_name": "<string>",
"state": None,
"subject": "<string>",
"type": None
}
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({
description: '<string>',
editor: null,
html: null,
name: null,
sender_email: '<string>',
sender_name: '<string>',
state: null,
subject: '<string>',
type: null
})
};
fetch('https://api.statisfy.com/v1/templates/{template_id}', 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.statisfy.com/v1/templates/{template_id}",
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([
'description' => '<string>',
'editor' => null,
'html' => null,
'name' => null,
'sender_email' => '<string>',
'sender_name' => '<string>',
'state' => null,
'subject' => '<string>',
'type' => null
]),
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.statisfy.com/v1/templates/{template_id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\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.statisfy.com/v1/templates/{template_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/templates/{template_id}")
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 \"description\": \"<string>\",\n \"editor\": null,\n \"html\": null,\n \"name\": null,\n \"sender_email\": \"<string>\",\n \"sender_name\": \"<string>\",\n \"state\": null,\n \"subject\": \"<string>\",\n \"type\": null\n}"
response = http.request(request)
puts response.read_body{
"attachments": [
{
"filename": "<string>",
"id": "<string>",
"mime_type": "<string>",
"size_bytes": 123
}
],
"created_at": "2023-11-07T05:31:56Z",
"creator": "<string>",
"description": "<string>",
"editor": "visual",
"html": "<string>",
"id": "<string>",
"merge_tags": [
"<string>"
],
"name": "<string>",
"sender_email": "<string>",
"sender_name": "<string>",
"state": "draft",
"subject": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"used_by_campaigns": 123
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
The email's HTML, with Jinja merge tags such as {{contact.first_name}}, {{account.name}}, {{user.name}} (the sender) and {{unsubscribe_this}} (the unsubscribe link's address). GET /v1/templates/merge-tags lists the workspace's. A merge tag with no value for a recipient renders empty, except a {{user.*}} tag (the sender): it takes its value from the person the campaign sends as through an owner role, and when there is no such person or their field is blank, the campaign's send fails. To change the HTML of a template built in the visual editor, send editor: html too
2000000Response
Successful Response
The email's HTML, with Jinja merge tags such as {{contact.first_name}}, {{account.name}}, {{user.name}} (the sender) and {{unsubscribe_this}} (the unsubscribe link's address). GET /v1/templates/merge-tags lists the workspace's. A merge tag with no value for a recipient renders empty, except a {{user.*}} tag (the sender): it takes its value from the person the campaign sends as through an owner role, and when there is no such person or their field is blank, the campaign's send fails
draft or published. The app offers only published templates when someone sets up a campaign or flow, but a campaign or flow already using a template reads it each time it sends, draft or published: a change goes out on its next send. Deleting a template is what stops it
draft, published Was this page helpful?