Create Email Template
curl --request POST \
--url https://api.politicalcomms.com/v1/email/templates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Fall fundraising",
"description": "Evergreen ask, brand colors",
"content": {
"subject": "Can you chip in before Friday?",
"preheader": "Every gift is matched through midnight.",
"html": "<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>"
}
}
'import requests
url = "https://api.politicalcomms.com/v1/email/templates"
payload = {
"name": "Fall fundraising",
"description": "Evergreen ask, brand colors",
"content": {
"subject": "Can you chip in before Friday?",
"preheader": "Every gift is matched through midnight.",
"html": "<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>"
}
}
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: 'Fall fundraising',
description: 'Evergreen ask, brand colors',
content: {
subject: 'Can you chip in before Friday?',
preheader: 'Every gift is matched through midnight.',
html: '<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>'
}
})
};
fetch('https://api.politicalcomms.com/v1/email/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://api.politicalcomms.com/v1/email/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' => 'Fall fundraising',
'description' => 'Evergreen ask, brand colors',
'content' => [
'subject' => 'Can you chip in before Friday?',
'preheader' => 'Every gift is matched through midnight.',
'html' => '<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>'
]
]),
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 := "https://api.politicalcomms.com/v1/email/templates"
payload := strings.NewReader("{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\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("https://api.politicalcomms.com/v1/email/templates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content": {
"subject": "<string>",
"preheader": "<string>",
"html": "<string>",
"text": "<string>",
"editor": "html"
},
"description": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"lint": {
"errors": [
{}
],
"warnings": [
{}
]
}
}
}Email Templates
Create Email Template
Create a template from raw HTML. The response carries a lint object beside the template: a template with lint errors saves, but a campaign using it will not schedule.
Early access. This endpoint returns 403 EMAIL_EARLY_ACCESS until the email product reaches general availability. The contract below is stable and safe to build against.
POST
/
email
/
templates
Create Email Template
curl --request POST \
--url https://api.politicalcomms.com/v1/email/templates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Fall fundraising",
"description": "Evergreen ask, brand colors",
"content": {
"subject": "Can you chip in before Friday?",
"preheader": "Every gift is matched through midnight.",
"html": "<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>"
}
}
'import requests
url = "https://api.politicalcomms.com/v1/email/templates"
payload = {
"name": "Fall fundraising",
"description": "Evergreen ask, brand colors",
"content": {
"subject": "Can you chip in before Friday?",
"preheader": "Every gift is matched through midnight.",
"html": "<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>"
}
}
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: 'Fall fundraising',
description: 'Evergreen ask, brand colors',
content: {
subject: 'Can you chip in before Friday?',
preheader: 'Every gift is matched through midnight.',
html: '<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>'
}
})
};
fetch('https://api.politicalcomms.com/v1/email/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://api.politicalcomms.com/v1/email/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' => 'Fall fundraising',
'description' => 'Evergreen ask, brand colors',
'content' => [
'subject' => 'Can you chip in before Friday?',
'preheader' => 'Every gift is matched through midnight.',
'html' => '<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>'
]
]),
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 := "https://api.politicalcomms.com/v1/email/templates"
payload := strings.NewReader("{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\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("https://api.politicalcomms.com/v1/email/templates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Fall fundraising\",\n \"description\": \"Evergreen ask, brand colors\",\n \"content\": {\n \"subject\": \"Can you chip in before Friday?\",\n \"preheader\": \"Every gift is matched through midnight.\",\n \"html\": \"<html><body><h1>Hi {first_name|Friend}</h1><p>Chip in today.</p></body></html>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content": {
"subject": "<string>",
"preheader": "<string>",
"html": "<string>",
"text": "<string>",
"editor": "html"
},
"description": "<string>",
"thumbnail_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"lint": {
"errors": [
{}
],
"warnings": [
{}
]
}
}
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.
Headers
Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.
Required string length:
16 - 200Body
application/json