Worked request and response samples

Copy a request body as written, substitute your own ids, and compare the response envelope. Errors follow Devotel Orbit’s { error, meta } envelope, shown once below under Error envelope.

Auto-winner governance. POST /campaigns/{id}/variants accepts three optional knobs that gate the automatic winner-promotion scheduler: ab_auto_promote (boolean | null — false keeps every promotion behind the manual POST /campaigns/{id}/ab-select-winner call, null resets to the default true), ab_min_sample_size (integer | null — deliveries the leading variant must reach before an automatic verdict, 10–1,000,000, null resets to the default 30), and ab_confidence_threshold (number | null — Bayesian posterior confidence required to promote, 0.500–0.999, null resets to the default 0.950). GET /campaigns/{id}/ab-results echoes those settings together with a live auto_winner_progress snapshot — the gate values the evaluator currently applies, the current leader, and whether it would already lock — so a dashboard can render real progress toward an automatic verdict. See the A/B testing guide.

Cross-channel governance in one call. GET /campaigns/{id}/governance-summary aggregates the four governance primitives a campaign’s settings panel previously issued four separate calls for: the A/B(n) experiment config plus auto-winner governance, the control hold-out cohort, the resolved quiet-hours window (with campaign / org_default / platform_default source attribution), and the effective frequency-cap rules — global rules folded in alongside channel-scoped rules, each labelled applies: true|false so the dashboard can place the badge without re-admitting the org-wide caps list client-side. Use this ONE round-trip when you render the “rules in effect” card; the individual sources stay available if you only want one.

Create a campaign

POST /api/v1/campaigns/

Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/campaigns/" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/campaigns/', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/campaigns/", headers=headers, json={
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/campaigns/", bytes.NewBuffer([]byte(`{
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/campaigns/')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/campaigns/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "name": "September win-back",
  "channel": "sms",
  "segment_id": "seg_7c4e2a9b1d3f50618293a4b5",
  "template_id": "tmpl_9e8d7c6b5a4f3021e5d6c7b8"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "cmp_1a2b3c4d5e6f7081a2b3c4d5",
    "name": "September win-back",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_create",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Check for overlapping schedules

POST /api/v1/campaigns/check-schedule-conflicts

Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts", headers=headers, json={
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts", bytes.NewBuffer([]byte(`{
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/campaigns/check-schedule-conflicts');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "scheduled_at": "2026-09-01T14:00:00.000Z",
  "channel": "sms"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "conflicts": [],
    "scheduled_at": "2026-09-01T14:00:00.000Z"
  },
  "meta": {
    "request_id": "req_schedule",
    "timestamp": "2026-08-01T12:01:00.000Z"
  }
}

Launch the campaign

POST /api/v1/campaigns/{id}/send

{
  "data": {
    "id": "cmp_1a2b3c4d5e6f7081a2b3c4d5",
    "status": "sending"
  },
  "meta": {
    "request_id": "req_launch",
    "timestamp": "2026-08-01T12:02:00.000Z"
  }
}

Error envelope

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "status": 422,
    "message": "name: Required"
  },
  "meta": {
    "request_id": "req_...",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Worked request and response samples