Schedule a new campaign mailing
curl --request POST \
--url https://api.paubox.com/v1/marketing/campaign_mailing_schedule \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"campaign_mailing_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"campaign_mailing_schedule": {
"send_at": "2023-05-01T15:00:00Z",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
"subject": "Your Campaign Subject Line",
"dynamic_list_id": "optional-uuid-for-dynamic-list",
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}
}
'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailing_schedule"
payload = {
"campaign_mailing_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"campaign_mailing_schedule": {
"send_at": "2023-05-01T15:00:00Z",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
"subject": "Your Campaign Subject Line",
"dynamic_list_id": "optional-uuid-for-dynamic-list",
"recipient_emails": ["test1@example.com", "test2@example.com"]
}
}
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: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
campaign_mailing_schedule: {
send_at: '2023-05-01T15:00:00Z',
from_email: 'no-reply@yourdomain.com',
from_name: 'Your Company Name',
sender_email: 'marketing@yourdomain.com',
subscription_list_id: '123e4567-e89b-12d3-a456-426614174000',
subject: 'Your Campaign Subject Line',
dynamic_list_id: 'optional-uuid-for-dynamic-list',
recipient_emails: ['test1@example.com', 'test2@example.com']
}
})
};
fetch('https://api.paubox.com/v1/marketing/campaign_mailing_schedule', 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_schedule",
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' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'campaign_mailing_schedule' => [
'send_at' => '2023-05-01T15:00:00Z',
'from_email' => 'no-reply@yourdomain.com',
'from_name' => 'Your Company Name',
'sender_email' => 'marketing@yourdomain.com',
'subscription_list_id' => '123e4567-e89b-12d3-a456-426614174000',
'subject' => 'Your Campaign Subject Line',
'dynamic_list_id' => 'optional-uuid-for-dynamic-list',
'recipient_emails' => [
'test1@example.com',
'test2@example.com'
]
]
]),
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_schedule"
payload := strings.NewReader("{\n \"campaign_mailing_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\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_schedule")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_mailing_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_schedule")
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\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"send_at": "2023-11-07T05:31:56Z",
"send_at_timestamp": "<string>",
"jid": "<string>"
}
}{
"errors": "Invalid time format provided, please use RFC3339 format."
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}Marketing · Campaigns
Schedule a campaign mailing with the Marketing API
Schedules a new email campaign mailing with specified details for delivery at a future time
POST
/
campaign_mailing_schedule
Schedule a new campaign mailing
curl --request POST \
--url https://api.paubox.com/v1/marketing/campaign_mailing_schedule \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"campaign_mailing_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"campaign_mailing_schedule": {
"send_at": "2023-05-01T15:00:00Z",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
"subject": "Your Campaign Subject Line",
"dynamic_list_id": "optional-uuid-for-dynamic-list",
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}
}
'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailing_schedule"
payload = {
"campaign_mailing_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"campaign_mailing_schedule": {
"send_at": "2023-05-01T15:00:00Z",
"from_email": "no-reply@yourdomain.com",
"from_name": "Your Company Name",
"sender_email": "marketing@yourdomain.com",
"subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
"subject": "Your Campaign Subject Line",
"dynamic_list_id": "optional-uuid-for-dynamic-list",
"recipient_emails": ["test1@example.com", "test2@example.com"]
}
}
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: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
campaign_mailing_schedule: {
send_at: '2023-05-01T15:00:00Z',
from_email: 'no-reply@yourdomain.com',
from_name: 'Your Company Name',
sender_email: 'marketing@yourdomain.com',
subscription_list_id: '123e4567-e89b-12d3-a456-426614174000',
subject: 'Your Campaign Subject Line',
dynamic_list_id: 'optional-uuid-for-dynamic-list',
recipient_emails: ['test1@example.com', 'test2@example.com']
}
})
};
fetch('https://api.paubox.com/v1/marketing/campaign_mailing_schedule', 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_schedule",
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' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'campaign_mailing_schedule' => [
'send_at' => '2023-05-01T15:00:00Z',
'from_email' => 'no-reply@yourdomain.com',
'from_name' => 'Your Company Name',
'sender_email' => 'marketing@yourdomain.com',
'subscription_list_id' => '123e4567-e89b-12d3-a456-426614174000',
'subject' => 'Your Campaign Subject Line',
'dynamic_list_id' => 'optional-uuid-for-dynamic-list',
'recipient_emails' => [
'test1@example.com',
'test2@example.com'
]
]
]),
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_schedule"
payload := strings.NewReader("{\n \"campaign_mailing_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\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_schedule")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_mailing_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_schedule")
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\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"campaign_mailing_schedule\": {\n \"send_at\": \"2023-05-01T15:00:00Z\",\n \"from_email\": \"no-reply@yourdomain.com\",\n \"from_name\": \"Your Company Name\",\n \"sender_email\": \"marketing@yourdomain.com\",\n \"subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"subject\": \"Your Campaign Subject Line\",\n \"dynamic_list_id\": \"optional-uuid-for-dynamic-list\",\n \"recipient_emails\": [\n \"test1@example.com\",\n \"test2@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"send_at": "2023-11-07T05:31:56Z",
"send_at_timestamp": "<string>",
"jid": "<string>"
}
}{
"errors": "Invalid time format provided, please use RFC3339 format."
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}{
"errors": [
{
"message": "401 Unauthorized"
}
]
}Authorizations
Token-based authentication. Use format: "Token token=YOUR_API_KEY" where YOUR_API_KEY is your API key
Body
application/json
Response
Campaign mailing scheduled successfully
Show child attributes
Show child attributes
⌘I