Plan a cross-campaign send schedule
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"global_cap_per_hour": 123,
"campaigns": [
{
"id": "<string>",
"volume": 123,
"priority": 123,
"pace_factor": 123
}
],
"slot_minutes": 123,
"quiet_hours": {
"start_hour": 123,
"end_hour": 123,
"tz_offset_minutes": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview"
payload = {
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"global_cap_per_hour": 123,
"campaigns": [
{
"id": "<string>",
"volume": 123,
"priority": 123,
"pace_factor": 123
}
],
"slot_minutes": 123,
"quiet_hours": {
"start_hour": 123,
"end_hour": 123,
"tz_offset_minutes": 123
}
}
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({
window_start: '2023-11-07T05:31:56Z',
window_end: '2023-11-07T05:31:56Z',
global_cap_per_hour: 123,
campaigns: [{id: '<string>', volume: 123, priority: 123, pace_factor: 123}],
slot_minutes: 123,
quiet_hours: {start_hour: 123, end_hour: 123, tz_offset_minutes: 123}
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview', 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/cross-schedule/preview",
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([
'window_start' => '2023-11-07T05:31:56Z',
'window_end' => '2023-11-07T05:31:56Z',
'global_cap_per_hour' => 123,
'campaigns' => [
[
'id' => '<string>',
'volume' => 123,
'priority' => 123,
'pace_factor' => 123
]
],
'slot_minutes' => 123,
'quiet_hours' => [
'start_hour' => 123,
'end_hour' => 123,
'tz_offset_minutes' => 123
]
]),
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/cross-schedule/preview"
payload := strings.NewReader("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}")
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/cross-schedule/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview")
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 = "{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"window_start": "<string>",
"window_end": "<string>",
"slot_minutes": 123,
"slot_capacity": 123,
"eligible_slots": 123,
"quiet_slots": 123,
"total_requested": 123,
"total_scheduled": 123,
"total_overflow": 123,
"peak_slot_utilization": 123,
"campaigns": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Campaigns
Plan a cross-campaign send schedule
Arbitrate a shared hourly frequency-cap budget across up to 100 campaigns: given a spread window, a global cap per hour, and an optional quiet-hour window it returns a per-campaign plan (recommended scheduled_at plus per-slot send counts). Read-only — apply the recommended times through the existing schedule path on each campaign.
POST
/
api
/
v1
/
campaigns
/
cross-schedule
/
preview
Plan a cross-campaign send schedule
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"global_cap_per_hour": 123,
"campaigns": [
{
"id": "<string>",
"volume": 123,
"priority": 123,
"pace_factor": 123
}
],
"slot_minutes": 123,
"quiet_hours": {
"start_hour": 123,
"end_hour": 123,
"tz_offset_minutes": 123
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview"
payload = {
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"global_cap_per_hour": 123,
"campaigns": [
{
"id": "<string>",
"volume": 123,
"priority": 123,
"pace_factor": 123
}
],
"slot_minutes": 123,
"quiet_hours": {
"start_hour": 123,
"end_hour": 123,
"tz_offset_minutes": 123
}
}
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({
window_start: '2023-11-07T05:31:56Z',
window_end: '2023-11-07T05:31:56Z',
global_cap_per_hour: 123,
campaigns: [{id: '<string>', volume: 123, priority: 123, pace_factor: 123}],
slot_minutes: 123,
quiet_hours: {start_hour: 123, end_hour: 123, tz_offset_minutes: 123}
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview', 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/cross-schedule/preview",
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([
'window_start' => '2023-11-07T05:31:56Z',
'window_end' => '2023-11-07T05:31:56Z',
'global_cap_per_hour' => 123,
'campaigns' => [
[
'id' => '<string>',
'volume' => 123,
'priority' => 123,
'pace_factor' => 123
]
],
'slot_minutes' => 123,
'quiet_hours' => [
'start_hour' => 123,
'end_hour' => 123,
'tz_offset_minutes' => 123
]
]),
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/cross-schedule/preview"
payload := strings.NewReader("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}")
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/cross-schedule/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/cross-schedule/preview")
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 = "{\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"global_cap_per_hour\": 123,\n \"campaigns\": [\n {\n \"id\": \"<string>\",\n \"volume\": 123,\n \"priority\": 123,\n \"pace_factor\": 123\n }\n ],\n \"slot_minutes\": 123,\n \"quiet_hours\": {\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"tz_offset_minutes\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"window_start": "<string>",
"window_end": "<string>",
"slot_minutes": 123,
"slot_capacity": 123,
"eligible_slots": 123,
"quiet_slots": 123,
"total_requested": 123,
"total_scheduled": 123,
"total_overflow": 123,
"peak_slot_utilization": 123,
"campaigns": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Spread-window start (must not be in the past).
Spread-window end (must be after window_start).
Shared hourly send cap arbitrated across the campaigns.
Campaign ids with optional explicit volume, priority, and pace factor.
Show child attributes
Show child attributes
Optional slot granularity in minutes (1-1440).
Optional quiet-hour window excluded from eligible slots.
Show child attributes
Show child attributes