curl --request POST \
--url https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule', 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/campaigns/{id}/unschedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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/campaigns/{id}/unschedule")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"sender_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"suppression_list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tracking_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tracking_domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"status": "<string>"
},
"require_approval": true,
"recipient_policy": "max_reach",
"approval_status": "not_required",
"last_tested_at": "2023-11-07T05:31:56Z",
"refcode": "<string>",
"source_code": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"audience_count": 123,
"counts": {
"queued": 123,
"sent": 123,
"delivered": 123,
"bounced": 123,
"complained": 123,
"unsubscribed": 123,
"opened": 123,
"clicked": 123,
"failed": 123
},
"pause_reason": "<string>",
"blocked": [
{
"code": "<string>",
"message": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Unschedule Campaign
Return a scheduled campaign to a draft state.
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/campaigns/{id}/unschedule \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule', 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/campaigns/{id}/unschedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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/campaigns/{id}/unschedule")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/email/campaigns/{id}/unschedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"sender_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"suppression_list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tracking_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tracking_domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"status": "<string>"
},
"require_approval": true,
"recipient_policy": "max_reach",
"approval_status": "not_required",
"last_tested_at": "2023-11-07T05:31:56Z",
"refcode": "<string>",
"source_code": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"audience_count": 123,
"counts": {
"queued": 123,
"sent": 123,
"delivered": 123,
"bounced": 123,
"complained": 123,
"unsubscribed": 123,
"opened": 123,
"clicked": 123,
"failed": 123
},
"pause_reason": "<string>",
"blocked": [
{
"code": "<string>",
"message": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}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
