Templates
Create a template
A template carries the layout; campaigns fill its editable area {{ zone.main }}.
POST
/
api
/
v1
/
templates
Create a template
curl --request POST \
--url https://{host}/api/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Lettre mensuelle",
"editor": "html",
"content": "<html><body><header>…</header>{{ zone.main }}<footer><a href=\"{{ unsubscribe_url }}\">Se désabonner</a></footer></body></html>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Lettre mensuelle',
editor: 'html',
content: '<html><body><header>…</header>{{ zone.main }}<footer><a href="{{ unsubscribe_url }}">Se désabonner</a></footer></body></html>'
})
};
fetch('https://{host}/api/v1/templates', 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://{host}/api/v1/templates",
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' => 'Lettre mensuelle',
'editor' => 'html',
'content' => '<html><body><header>…</header>{{ zone.main }}<footer><a href="{{ unsubscribe_url }}">Se désabonner</a></footer></body></html>'
]),
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;
}import requests
url = "https://{host}/api/v1/templates"
payload = {
"name": "Lettre mensuelle",
"editor": "html",
"content": "<html><body><header>…</header>{{ zone.main }}<footer><a href=\"{{ unsubscribe_url }}\">Se désabonner</a></footer></body></html>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"editor": "blocks",
"content": "<string>",
"styles": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "Unauthenticated."
}{
"message": "<string>"
}{
"message": "The email field must be a valid email address.",
"errors": {}
}Authorizations
An API token. The "read" ability: GET routes only. "read + write": every route.
Headers
Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).
Maximum string length:
255Body
application/json
Response
The template that was created.
Show child attributes
Show child attributes
⌘I
Create a template
curl --request POST \
--url https://{host}/api/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Lettre mensuelle",
"editor": "html",
"content": "<html><body><header>…</header>{{ zone.main }}<footer><a href=\"{{ unsubscribe_url }}\">Se désabonner</a></footer></body></html>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Lettre mensuelle',
editor: 'html',
content: '<html><body><header>…</header>{{ zone.main }}<footer><a href="{{ unsubscribe_url }}">Se désabonner</a></footer></body></html>'
})
};
fetch('https://{host}/api/v1/templates', 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://{host}/api/v1/templates",
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' => 'Lettre mensuelle',
'editor' => 'html',
'content' => '<html><body><header>…</header>{{ zone.main }}<footer><a href="{{ unsubscribe_url }}">Se désabonner</a></footer></body></html>'
]),
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;
}import requests
url = "https://{host}/api/v1/templates"
payload = {
"name": "Lettre mensuelle",
"editor": "html",
"content": "<html><body><header>…</header>{{ zone.main }}<footer><a href=\"{{ unsubscribe_url }}\">Se désabonner</a></footer></body></html>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"editor": "blocks",
"content": "<string>",
"styles": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "Unauthenticated."
}{
"message": "<string>"
}{
"message": "The email field must be a valid email address.",
"errors": {}
}