Set A/B variants and governance
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variants": [
{
"variant_index": 123,
"subject": "<string>",
"message": "<string>",
"sample_percent": 50
}
],
"ab_holdout_percent": 25,
"ab_bandit": true,
"ab_auto_promote": true,
"ab_min_sample_size": 123,
"ab_confidence_threshold": 123
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants"
payload = {
"variants": [
{
"variant_index": 123,
"subject": "<string>",
"message": "<string>",
"sample_percent": 50
}
],
"ab_holdout_percent": 25,
"ab_bandit": True,
"ab_auto_promote": True,
"ab_min_sample_size": 123,
"ab_confidence_threshold": 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({
variants: [
{
variant_index: 123,
subject: '<string>',
message: '<string>',
sample_percent: 50
}
],
ab_holdout_percent: 25,
ab_bandit: true,
ab_auto_promote: true,
ab_min_sample_size: 123,
ab_confidence_threshold: 123
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants', 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}/variants",
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([
'variants' => [
[
'variant_index' => 123,
'subject' => '<string>',
'message' => '<string>',
'sample_percent' => 50
]
],
'ab_holdout_percent' => 25,
'ab_bandit' => true,
'ab_auto_promote' => true,
'ab_min_sample_size' => 123,
'ab_confidence_threshold' => 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/{id}/variants"
payload := strings.NewReader("{\n \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\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/{id}/variants")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants")
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 \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"variants": [
{}
]
},
"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
Set A/B variants and governance
Full-replace the A/B variant set (2–4 variants) of a campaign and/or update its experiment governance: winner metric, holdout percent, bandit toggle, and the auto-promote sample-size/confidence thresholds. Because variants is optional, a governance-only call updates just those columns without redistributing traffic evenly across variant rows.
POST
/
api
/
v1
/
campaigns
/
{id}
/
variants
Set A/B variants and governance
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variants": [
{
"variant_index": 123,
"subject": "<string>",
"message": "<string>",
"sample_percent": 50
}
],
"ab_holdout_percent": 25,
"ab_bandit": true,
"ab_auto_promote": true,
"ab_min_sample_size": 123,
"ab_confidence_threshold": 123
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants"
payload = {
"variants": [
{
"variant_index": 123,
"subject": "<string>",
"message": "<string>",
"sample_percent": 50
}
],
"ab_holdout_percent": 25,
"ab_bandit": True,
"ab_auto_promote": True,
"ab_min_sample_size": 123,
"ab_confidence_threshold": 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({
variants: [
{
variant_index: 123,
subject: '<string>',
message: '<string>',
sample_percent: 50
}
],
ab_holdout_percent: 25,
ab_bandit: true,
ab_auto_promote: true,
ab_min_sample_size: 123,
ab_confidence_threshold: 123
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants', 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}/variants",
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([
'variants' => [
[
'variant_index' => 123,
'subject' => '<string>',
'message' => '<string>',
'sample_percent' => 50
]
],
'ab_holdout_percent' => 25,
'ab_bandit' => true,
'ab_auto_promote' => true,
'ab_min_sample_size' => 123,
'ab_confidence_threshold' => 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/{id}/variants"
payload := strings.NewReader("{\n \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\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/{id}/variants")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants")
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 \"variants\": [\n {\n \"variant_index\": 123,\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"sample_percent\": 50\n }\n ],\n \"ab_holdout_percent\": 25,\n \"ab_bandit\": true,\n \"ab_auto_promote\": true,\n \"ab_min_sample_size\": 123,\n \"ab_confidence_threshold\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"variants": [
{}
]
},
"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 Path Parameters
Resource identifier
Minimum string length:
1Body
application/json
Required array length:
2 - 4 elementsShow child attributes
Show child attributes
Available options:
delivered, opened, clicked, replied Required range:
1 <= x <= 50