curl --request POST \
--url https://api.politicalcomms.com/v1/email/lists/{id}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contacts": [
{
"email": "voter@example.com",
"fields": {
"first_name": "Ada"
},
"consent_source": "webform"
}
]
}
'import requests
url = "https://api.politicalcomms.com/v1/email/lists/{id}/contacts"
payload = { "contacts": [
{
"email": "voter@example.com",
"fields": { "first_name": "Ada" },
"consent_source": "webform"
}
] }
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({
contacts: [
{
email: 'voter@example.com',
fields: {first_name: 'Ada'},
consent_source: 'webform'
}
]
})
};
fetch('https://api.politicalcomms.com/v1/email/lists/{id}/contacts', 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/lists/{id}/contacts",
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([
'contacts' => [
[
'email' => 'voter@example.com',
'fields' => [
'first_name' => 'Ada'
],
'consent_source' => 'webform'
]
]
]),
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/lists/{id}/contacts"
payload := strings.NewReader("{\n \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\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/lists/{id}/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/lists/{id}/contacts")
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 \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"written": 123,
"accepted": 123,
"rejected": 123,
"duplicates": 123,
"results": [
{
"index": 123,
"email": "<string>",
"status": "accepted",
"reason": "<string>"
}
]
}
}Add Contacts
Upsert up to 1,000 contacts in one call. Invalid rows do not fail the request: every row comes back with its own outcome so you can fix just the rejected ones.
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.
curl --request POST \
--url https://api.politicalcomms.com/v1/email/lists/{id}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contacts": [
{
"email": "voter@example.com",
"fields": {
"first_name": "Ada"
},
"consent_source": "webform"
}
]
}
'import requests
url = "https://api.politicalcomms.com/v1/email/lists/{id}/contacts"
payload = { "contacts": [
{
"email": "voter@example.com",
"fields": { "first_name": "Ada" },
"consent_source": "webform"
}
] }
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({
contacts: [
{
email: 'voter@example.com',
fields: {first_name: 'Ada'},
consent_source: 'webform'
}
]
})
};
fetch('https://api.politicalcomms.com/v1/email/lists/{id}/contacts', 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/lists/{id}/contacts",
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([
'contacts' => [
[
'email' => 'voter@example.com',
'fields' => [
'first_name' => 'Ada'
],
'consent_source' => 'webform'
]
]
]),
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/lists/{id}/contacts"
payload := strings.NewReader("{\n \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\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/lists/{id}/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/lists/{id}/contacts")
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 \"contacts\": [\n {\n \"email\": \"voter@example.com\",\n \"fields\": {\n \"first_name\": \"Ada\"\n },\n \"consent_source\": \"webform\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"written": 123,
"accepted": 123,
"rejected": 123,
"duplicates": 123,
"results": [
{
"index": 123,
"email": "<string>",
"status": "accepted",
"reason": "<string>"
}
]
}
}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.
16 - 200Path Parameters
Resource ID
Body
1 - 1000 elementsShow child attributes
Show child attributes
