Preview a campaign launch (dry run)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run', 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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"channel": "<string>",
"evaluated_at": "2023-11-07T05:31:56Z",
"audience": {
"total_in_audience": 123,
"suppressed": 123,
"opted_out": 123,
"unreachable": 123,
"held_out": 123,
"deliverable": 123,
"audience_type": "<string>",
"audience_id": "<string>"
},
"cost": {
"unit_price_cents": 123,
"total_cents": 123,
"balance_cents": 123,
"sufficient": true,
"formatted_total_usd": "<string>",
"formatted_balance_usd": "<string>",
"currency": "<string>"
},
"quiet_hours": {
"enabled": true,
"skipped_estimate": 123,
"sample_size": 123,
"sample_skipped": 123
},
"channel_waterfall": {
"primary": "<string>",
"primary_provider_available": true,
"primary_channel_connected": true,
"primary_sender": {
"identity": "<string>",
"type": "dedicated"
},
"cross_channel_fallback": [
"<string>"
],
"cross_channel_fallback_available": [
{
"channel": "<string>",
"provider_available": true,
"channel_connected": true
}
]
},
"personalization": {
"variables": [
"<string>"
],
"unresolved": [
"<string>"
],
"coverage": [
{
"variable": "<string>",
"field": "<string>",
"present": 123,
"sampled": 123
}
]
},
"provider_readiness": {
"status": "pass",
"checks": [
{
"id": "<string>",
"label": "<string>",
"status": "pass",
"detail": "<string>",
"structural": true
}
]
},
"warnings": [
"<string>"
],
"ready_to_launch": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Campaigns
Preview a campaign launch (dry run)
Returns a read-only snapshot of what would happen if the campaign launched right now — resolved audience size with the suppressed / opted-out / unreachable / held-out / deliverable breakdown, projected cost against the wallet balance (from the same pricing lane the send path bills on), a quiet-hours skip estimate, the channel-fallback waterfall with provider readiness, personalization coverage, non-blocking warnings, and a ready_to_launch verdict. It never mutates state, never touches the wallet, and never enqueues a job — safe to call on every keystroke of the launch wizard. No request body fields are read.
POST
/
api
/
v1
/
campaigns
/
{id}
/
dry-run
Preview a campaign launch (dry run)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run', 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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/campaigns/{id}/dry-run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/dry-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"channel": "<string>",
"evaluated_at": "2023-11-07T05:31:56Z",
"audience": {
"total_in_audience": 123,
"suppressed": 123,
"opted_out": 123,
"unreachable": 123,
"held_out": 123,
"deliverable": 123,
"audience_type": "<string>",
"audience_id": "<string>"
},
"cost": {
"unit_price_cents": 123,
"total_cents": 123,
"balance_cents": 123,
"sufficient": true,
"formatted_total_usd": "<string>",
"formatted_balance_usd": "<string>",
"currency": "<string>"
},
"quiet_hours": {
"enabled": true,
"skipped_estimate": 123,
"sample_size": 123,
"sample_skipped": 123
},
"channel_waterfall": {
"primary": "<string>",
"primary_provider_available": true,
"primary_channel_connected": true,
"primary_sender": {
"identity": "<string>",
"type": "dedicated"
},
"cross_channel_fallback": [
"<string>"
],
"cross_channel_fallback_available": [
{
"channel": "<string>",
"provider_available": true,
"channel_connected": true
}
]
},
"personalization": {
"variables": [
"<string>"
],
"unresolved": [
"<string>"
],
"coverage": [
{
"variable": "<string>",
"field": "<string>",
"present": 123,
"sampled": 123
}
]
},
"provider_readiness": {
"status": "pass",
"checks": [
{
"id": "<string>",
"label": "<string>",
"status": "pass",
"detail": "<string>",
"structural": true
}
]
},
"warnings": [
"<string>"
],
"ready_to_launch": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
No body fields are read — send an empty object.
⌘I