Duplicate template
curl --request POST \
--url http://localhost:3001/api/v1/templates/{id}/duplicate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/templates/{id}/duplicate"
payload = { "name": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('http://localhost:3001/api/v1/templates/{id}/duplicate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/templates/{id}/duplicate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/templates/{id}/duplicate"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("http://localhost:3001/api/v1/templates/{id}/duplicate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/templates/{id}/duplicate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contentRevision": 4503599627370495,
"name": "<string>",
"key": "<string>",
"type": "<string>",
"status": "Active",
"resourceType": "<string>",
"senderProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brandKitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "General",
"defaultSegmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateAuthoring": {
"version": "template-authoring.v2",
"mode": "manual_message_document",
"modeSource": "declared",
"label": "Manual editor",
"manualMessageDocument": {
"compatible": true,
"reasons": [
"template_archived"
]
},
"manualBroadcast": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"manualNewsletter": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"automatedEmailSpec": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"defaultDesign": {
"selectable": true,
"reasons": [
"template_archived"
]
}
},
"source": "<string>",
"language": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"definition": {
"type": "Email",
"emailContentsType": "Code",
"codeFormat": "json",
"purpose": "General",
"from": "",
"subject": "",
"body": {
"specVersion": "email-spec.v1",
"root": "<string>",
"elements": {}
},
"subType": "<string>",
"authoringMode": "manual_message_document",
"replyTo": "<string>",
"preheader": "<string>",
"defaultBody": {
"type": "doc",
"content": [
"<unknown>"
]
},
"renderVariables": {},
"sensitiveTransactionalVariablePaths": [
"<string>"
],
"designProfile": {
"version": "email-design-profile.v1",
"source": {
"brandKitId": "<string>",
"brandKitRevision": "<string>",
"semanticHash": "<string>"
},
"artDirection": {
"id": "<string>",
"conceptName": "<string>",
"rationale": "<string>",
"doNot": [
"<string>"
],
"contentDensity": "airy",
"heroTreatment": "copy_first",
"paletteStrategy": "neutral_dominant",
"ctaEmphasis": "primary"
},
"paletteStrategy": "neutral_dominant",
"colors": {
"canvas": "<string>",
"surface": "<string>",
"surfaceMuted": "<string>",
"ink": "<string>",
"inkMuted": "<string>",
"action": "<string>",
"actionText": "<string>",
"accent": "<string>",
"accentText": "<string>",
"footerSurface": "<string>",
"footerText": "<string>",
"border": "<string>",
"link": "<string>"
},
"allowedPairings": [
{
"foregroundRole": "canvas",
"backgroundRole": "canvas",
"contrastRatio": 11,
"requiredRatio": 11
}
],
"typography": {
"headingFont": "<string>",
"bodyFont": "<string>",
"headingWeight": 700,
"bodyWeight": 400
},
"spacing": {
"sectionPadding": 60,
"blockGap": 40,
"contentMaxWidth": 520
},
"shape": {
"buttonRadius": 16,
"cardRadius": 16
},
"imagery": {
"treatment": "none",
"aspectRatio": "natural"
},
"socialIconStyle": "monochrome",
"warnings": []
},
"brandOverrides": {}
},
"definitionCompatibility": {
"status": "ok",
"expectedVersion": "email-spec.v1",
"fromVersion": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
],
"canAutoRepair": true,
"reason": "missing_spec_version"
},
"sourceMetadata": null,
"currentEmailInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"kind": "percentage",
"amount": "<string>",
"currency": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"retryAfterSeconds": 12
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Templates
Duplicate template
Create an editable copy of an existing template in the current organization
POST
/
api
/
v1
/
templates
/
{id}
/
duplicate
Duplicate template
curl --request POST \
--url http://localhost:3001/api/v1/templates/{id}/duplicate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/templates/{id}/duplicate"
payload = { "name": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('http://localhost:3001/api/v1/templates/{id}/duplicate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/templates/{id}/duplicate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/templates/{id}/duplicate"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("http://localhost:3001/api/v1/templates/{id}/duplicate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/templates/{id}/duplicate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contentRevision": 4503599627370495,
"name": "<string>",
"key": "<string>",
"type": "<string>",
"status": "Active",
"resourceType": "<string>",
"senderProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brandKitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "General",
"defaultSegmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateAuthoring": {
"version": "template-authoring.v2",
"mode": "manual_message_document",
"modeSource": "declared",
"label": "Manual editor",
"manualMessageDocument": {
"compatible": true,
"reasons": [
"template_archived"
]
},
"manualBroadcast": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"manualNewsletter": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"automatedEmailSpec": {
"selectable": true,
"reasons": [
"template_archived"
]
},
"defaultDesign": {
"selectable": true,
"reasons": [
"template_archived"
]
}
},
"source": "<string>",
"language": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"definition": {
"type": "Email",
"emailContentsType": "Code",
"codeFormat": "json",
"purpose": "General",
"from": "",
"subject": "",
"body": {
"specVersion": "email-spec.v1",
"root": "<string>",
"elements": {}
},
"subType": "<string>",
"authoringMode": "manual_message_document",
"replyTo": "<string>",
"preheader": "<string>",
"defaultBody": {
"type": "doc",
"content": [
"<unknown>"
]
},
"renderVariables": {},
"sensitiveTransactionalVariablePaths": [
"<string>"
],
"designProfile": {
"version": "email-design-profile.v1",
"source": {
"brandKitId": "<string>",
"brandKitRevision": "<string>",
"semanticHash": "<string>"
},
"artDirection": {
"id": "<string>",
"conceptName": "<string>",
"rationale": "<string>",
"doNot": [
"<string>"
],
"contentDensity": "airy",
"heroTreatment": "copy_first",
"paletteStrategy": "neutral_dominant",
"ctaEmphasis": "primary"
},
"paletteStrategy": "neutral_dominant",
"colors": {
"canvas": "<string>",
"surface": "<string>",
"surfaceMuted": "<string>",
"ink": "<string>",
"inkMuted": "<string>",
"action": "<string>",
"actionText": "<string>",
"accent": "<string>",
"accentText": "<string>",
"footerSurface": "<string>",
"footerText": "<string>",
"border": "<string>",
"link": "<string>"
},
"allowedPairings": [
{
"foregroundRole": "canvas",
"backgroundRole": "canvas",
"contrastRatio": 11,
"requiredRatio": 11
}
],
"typography": {
"headingFont": "<string>",
"bodyFont": "<string>",
"headingWeight": 700,
"bodyWeight": 400
},
"spacing": {
"sectionPadding": 60,
"blockGap": 40,
"contentMaxWidth": 520
},
"shape": {
"buttonRadius": 16,
"cardRadius": 16
},
"imagery": {
"treatment": "none",
"aspectRatio": "natural"
},
"socialIconStyle": "monochrome",
"warnings": []
},
"brandOverrides": {}
},
"definitionCompatibility": {
"status": "ok",
"expectedVersion": "email-spec.v1",
"fromVersion": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
],
"canAutoRepair": true,
"reason": "missing_spec_version"
},
"sourceMetadata": null,
"currentEmailInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"kind": "percentage",
"amount": "<string>",
"currency": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"retryAfterSeconds": 12
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Path Parameters
Body
application/json
Response
Default Response
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
