Send a test email
curl --request GET \
--url https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email \
--header 'authorization: <api-key>'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email', 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_mailings/{campaign_mailing_id}/send_test_email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Marketing · Campaigns
Send a test email with the Marketing API
Sends a one-off preview of the campaign mailing to a single address, so you can check rendering before sending to a list. The subject is prefixed with [Test], and the message is sent from your account’s default brand from_email and from_name.
Test sends are not recorded as a campaign send and do not appear in analytics.
Example curl command:
curl -X GET \
'https://api.paubox.com/v1/marketing/campaign_mailings/123e4567-e89b-12d3-a456-426614174000/send_test_email?to_email=me@example.com' \
-H 'authorization: Token token=YOUR_API_KEY'
GET
/
campaign_mailings
/
{campaign_mailing_id}
/
send_test_email
Send a test email
curl --request GET \
--url https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email \
--header 'authorization: <api-key>'import requests
url = "https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email', 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_mailings/{campaign_mailing_id}/send_test_email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paubox.com/v1/marketing/campaign_mailings/{campaign_mailing_id}/send_test_email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
Path Parameters
UUID of the campaign mailing
Query Parameters
Address to send the test message to
Response
Test email queued. The response has no body.
⌘I