Assign a template to a template group
curl --request PUT \
--url http://localhost:3001/api/v1/templates/{id}/template-group \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"assignment": {
"templateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>"
}
}
'import requests
url = "http://localhost:3001/api/v1/templates/{id}/template-group"
payload = { "assignment": {
"templateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assignment: {templateGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', locale: '<string>'}
})
};
fetch('http://localhost:3001/api/v1/templates/{id}/template-group', 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}/template-group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'assignment' => [
'templateGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'locale' => '<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}/template-group"
payload := strings.NewReader("{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/templates/{id}/template-group")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/templates/{id}/template-group")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key": "<string>",
"defaultLocale": "<string>",
"fallbackMode": "UseGroupDefault",
"mappingRevision": 4503599627370495,
"description": "<string>",
"source": "<string>",
"generationConfigurationStatus": "configured",
"purpose": "General",
"mappings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>",
"isDefault": true,
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateName": "<string>",
"templateLanguage": "<string>",
"templatePurpose": "General",
"templateStatus": "Active",
"templateIsComplete": true,
"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"
]
}
},
"languageOverrideApproved": true,
"generationStatus": "pending",
"generationError": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "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": "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
}
}Templates
Assign a template to a template group
PUT
/
api
/
v1
/
templates
/
{id}
/
template-group
Assign a template to a template group
curl --request PUT \
--url http://localhost:3001/api/v1/templates/{id}/template-group \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"assignment": {
"templateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>"
}
}
'import requests
url = "http://localhost:3001/api/v1/templates/{id}/template-group"
payload = { "assignment": {
"templateGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assignment: {templateGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', locale: '<string>'}
})
};
fetch('http://localhost:3001/api/v1/templates/{id}/template-group', 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}/template-group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'assignment' => [
'templateGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'locale' => '<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}/template-group"
payload := strings.NewReader("{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/templates/{id}/template-group")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/templates/{id}/template-group")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assignment\": {\n \"templateGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locale\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key": "<string>",
"defaultLocale": "<string>",
"fallbackMode": "UseGroupDefault",
"mappingRevision": 4503599627370495,
"description": "<string>",
"source": "<string>",
"generationConfigurationStatus": "configured",
"purpose": "General",
"mappings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>",
"isDefault": true,
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateName": "<string>",
"templateLanguage": "<string>",
"templatePurpose": "General",
"templateStatus": "Active",
"templateIsComplete": true,
"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"
]
}
},
"languageOverrideApproved": true,
"generationStatus": "pending",
"generationError": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "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": "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
}
}Path Parameters
Response
object | null
Reusable locale-to-Template map used to seed localized drafts. Not editable send-time content.
Reusable locale-to-Template map used to seed localized drafts. Not editable send-time content.
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))$
