Send campaign mailings
curl --request POST \
--url https://api.paubox.com/v1/marketing/campaign_mailing_sends \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"campaign_mailing_id": "g79da293-4a84-4b50-b0d9-76a16af167fe",
"campaign_mailing_send": {
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "1a55ec71-0b08-457a-b183-51ac7791f1fe",
"recipient_emails": [
"test1@example.com",
"test2@example.com"
],
"customer_name": "Your Company",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"subject": "Your Campaign Subject"
}
}
'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailing_sends"
payload = {
"campaign_mailing_id": "g79da293-4a84-4b50-b0d9-76a16af167fe",
"campaign_mailing_send": {
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "1a55ec71-0b08-457a-b183-51ac7791f1fe",
"recipient_emails": ["test1@example.com", "test2@example.com"],
"customer_name": "Your Company",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"subject": "Your Campaign Subject"
}
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_mailing_id: 'g79da293-4a84-4b50-b0d9-76a16af167fe',
campaign_mailing_send: {
sender_email: 'marketing@yourdomain.com',
subscription_list_id: '1a55ec71-0b08-457a-b183-51ac7791f1fe',
recipient_emails: ['test1@example.com', 'test2@example.com'],
customer_name: 'Your Company',
from_email: 'no-reply@yourdomain.com',
from_name: 'Your Company Name',
subject: 'Your Campaign Subject'
}
})
};
fetch('https://api.paubox.com/v1/marketing/campaign_mailing_sends', 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.paubox.com/v1/marketing/campaign_mailing_sends",
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([
'campaign_mailing_id' => 'g79da293-4a84-4b50-b0d9-76a16af167fe',
'campaign_mailing_send' => [
'sender_email' => 'marketing@yourdomain.com',
'subscription_list_id' => '1a55ec71-0b08-457a-b183-51ac7791f1fe',
'recipient_emails' => [
'test1@example.com',
'test2@example.com'
],
'customer_name' => 'Your Company',
'from_email' => 'no-reply@yourdomain.com',
'from_name' => 'Your Company Name',
'subject' => 'Your Campaign Subject'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <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.paubox.com/v1/marketing/campaign_mailing_sends"
payload := strings.NewReader("{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<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.paubox.com/v1/marketing/campaign_mailing_sends")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_sends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Marketing · Campaigns
Send a campaign mailing
Send campaign email to recipients. The email message must be created within the Paubox Marketing web interface in order to use this to trigger a send.
Note: The campaign_mailing_id can be retrieved from the id= part of the URL when editing a marketing email. The subscription_list_id can be retrieved from the listId= part of the URL of any Contact List page.
POST
/
campaign_mailing_sends
Send campaign mailings
curl --request POST \
--url https://api.paubox.com/v1/marketing/campaign_mailing_sends \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"campaign_mailing_id": "g79da293-4a84-4b50-b0d9-76a16af167fe",
"campaign_mailing_send": {
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "1a55ec71-0b08-457a-b183-51ac7791f1fe",
"recipient_emails": [
"test1@example.com",
"test2@example.com"
],
"customer_name": "Your Company",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"subject": "Your Campaign Subject"
}
}
'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailing_sends"
payload = {
"campaign_mailing_id": "g79da293-4a84-4b50-b0d9-76a16af167fe",
"campaign_mailing_send": {
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "1a55ec71-0b08-457a-b183-51ac7791f1fe",
"recipient_emails": ["test1@example.com", "test2@example.com"],
"customer_name": "Your Company",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"subject": "Your Campaign Subject"
}
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_mailing_id: 'g79da293-4a84-4b50-b0d9-76a16af167fe',
campaign_mailing_send: {
sender_email: 'marketing@yourdomain.com',
subscription_list_id: '1a55ec71-0b08-457a-b183-51ac7791f1fe',
recipient_emails: ['test1@example.com', 'test2@example.com'],
customer_name: 'Your Company',
from_email: 'no-reply@yourdomain.com',
from_name: 'Your Company Name',
subject: 'Your Campaign Subject'
}
})
};
fetch('https://api.paubox.com/v1/marketing/campaign_mailing_sends', 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.paubox.com/v1/marketing/campaign_mailing_sends",
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([
'campaign_mailing_id' => 'g79da293-4a84-4b50-b0d9-76a16af167fe',
'campaign_mailing_send' => [
'sender_email' => 'marketing@yourdomain.com',
'subscription_list_id' => '1a55ec71-0b08-457a-b183-51ac7791f1fe',
'recipient_emails' => [
'test1@example.com',
'test2@example.com'
],
'customer_name' => 'Your Company',
'from_email' => 'no-reply@yourdomain.com',
'from_name' => 'Your Company Name',
'subject' => 'Your Campaign Subject'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <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.paubox.com/v1/marketing/campaign_mailing_sends"
payload := strings.NewReader("{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<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.paubox.com/v1/marketing/campaign_mailing_sends")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_sends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_mailing_id\": \"g79da293-4a84-4b50-b0d9-76a16af167fe\",\n \"campaign_mailing_send\": {\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"1a55ec71-0b08-457a-b183-51ac7791f1fe\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ],\n \"customer_name\": \"Your Company\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"subject\": \"Your Campaign Subject\"\n }\n}"
response = http.request(request)
puts response.read_body{}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key
Body
application/json
Response
Campaign mailing sent successfully
The response is of type object.
⌘I