Schedule a campaign mailing

Schedule a new campaign mailing

curl --request POST \
  --url https://api.paubox.com/v1/marketing/campaign_mailing_schedules \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "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_schedules"

payload = {
    "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({
    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_schedules', 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_schedules",
  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([
    '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_schedules"

	payload := strings.NewReader("{\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}")

	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_schedules")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_schedules")

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  \"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}"

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."
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

POST

campaign_mailing_schedules

Schedule a new campaign mailing

curl --request POST \
  --url https://api.paubox.com/v1/marketing/campaign_mailing_schedules \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "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_schedules"

payload = {
    "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({
    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_schedules', 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_schedules",
  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([
    '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_schedules"

	payload := strings.NewReader("{\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}")

	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_schedules")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/campaign_mailing_schedules")

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  \"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}"

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."
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Body

application/json

send_at

string<date-time>

required

The time at which to send the campaign, in RFC3339 format

from_email

string<email>

required

The email address from which the campaign will be sent. It should be from a verified domain from your Paubox Marketing settings page

from_name

string

required

The name to appear as the sender of the campaign

sender_email

string<email>

required

The email address of the person/entity sending this email. Should be a Paubox user email address and is NOT going to appear as the From email

subscription_list_id

string<uuid>

required

The uuid of the subscription list to which the campaign will be sent

subject

string

required

The subject line of the campaign mailing

dynamic_list_id

string<uuid>

The uuid of the dynamic list to which the campaign will be sent (optional)

recipient_emails

string<email>[]

A list of extra recipient email addresses for the campaign to be sent to. These are not tracked for analytics purposes and are usually just for verification and/or testing

Response

Campaign mailing scheduled successfully

data

object

Show child attributes

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Schedule a campaign mailing

Authorizations

Body

Response