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": [
{
"name": "Variant A",
"message_body": "Flash sale — 20% off ends tonight.",
"variant_index": 0
},
{
"name": "Variant B",
"message_body": "Last chance: save 20% before midnight.",
"variant_index": 1
}
],
"ab_winner_metric": "clicked",
"ab_holdout_percent": 10
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants"
payload = {
"variants": [
{
"name": "Variant A",
"message_body": "Flash sale — 20% off ends tonight.",
"variant_index": 0
},
{
"name": "Variant B",
"message_body": "Last chance: save 20% before midnight.",
"variant_index": 1
}
],
"ab_winner_metric": "clicked",
"ab_holdout_percent": 10
}
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: [
{
name: 'Variant A',
message_body: 'Flash sale — 20% off ends tonight.',
variant_index: 0
},
{
name: 'Variant B',
message_body: 'Last chance: save 20% before midnight.',
variant_index: 1
}
],
ab_winner_metric: 'clicked',
ab_holdout_percent: 10
})
};
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' => [
[
'name' => 'Variant A',
'message_body' => 'Flash sale — 20% off ends tonight.',
'variant_index' => 0
],
[
'name' => 'Variant B',
'message_body' => 'Last chance: save 20% before midnight.',
'variant_index' => 1
]
],
'ab_winner_metric' => 'clicked',
'ab_holdout_percent' => 10
]),
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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\n}"
response = http.request(request)
puts response.read_body{
"data": {
"variants": [
{
"id": "<string>",
"name": "<string>",
"message_body": "<string>",
"variant_index": 123
}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Set a campaign's A/B variants
Configures multi-variant A/B testing on a campaign. Send a variants array (2–4 variants, each with a unique variant_index and a message body) to replace the variant set, and/or set the winner metric, holdout percentage, and multi-armed bandit toggle. All body fields are individually optional, but at least one must be present — a metric/holdout/bandit-only call updates those settings without touching the variant rows. Returns the resulting variant set.
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": [
{
"name": "Variant A",
"message_body": "Flash sale — 20% off ends tonight.",
"variant_index": 0
},
{
"name": "Variant B",
"message_body": "Last chance: save 20% before midnight.",
"variant_index": 1
}
],
"ab_winner_metric": "clicked",
"ab_holdout_percent": 10
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/variants"
payload = {
"variants": [
{
"name": "Variant A",
"message_body": "Flash sale — 20% off ends tonight.",
"variant_index": 0
},
{
"name": "Variant B",
"message_body": "Last chance: save 20% before midnight.",
"variant_index": 1
}
],
"ab_winner_metric": "clicked",
"ab_holdout_percent": 10
}
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: [
{
name: 'Variant A',
message_body: 'Flash sale — 20% off ends tonight.',
variant_index: 0
},
{
name: 'Variant B',
message_body: 'Last chance: save 20% before midnight.',
variant_index: 1
}
],
ab_winner_metric: 'clicked',
ab_holdout_percent: 10
})
};
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' => [
[
'name' => 'Variant A',
'message_body' => 'Flash sale — 20% off ends tonight.',
'variant_index' => 0
],
[
'name' => 'Variant B',
'message_body' => 'Last chance: save 20% before midnight.',
'variant_index' => 1
]
],
'ab_winner_metric' => 'clicked',
'ab_holdout_percent' => 10
]),
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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\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 \"name\": \"Variant A\",\n \"message_body\": \"Flash sale — 20% off ends tonight.\",\n \"variant_index\": 0\n },\n {\n \"name\": \"Variant B\",\n \"message_body\": \"Last chance: save 20% before midnight.\",\n \"variant_index\": 1\n }\n ],\n \"ab_winner_metric\": \"clicked\",\n \"ab_holdout_percent\": 10\n}"
response = http.request(request)
puts response.read_body{
"data": {
"variants": [
{
"id": "<string>",
"name": "<string>",
"message_body": "<string>",
"variant_index": 123
}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Path Parameters
Body
Full replacement variant set. Each variant needs a unique variant_index.
2 - 4 elementsShow child attributes
Show child attributes
Metric used to pick the winning variant.
delivered, opened, clicked, replied Percentage of the audience withheld from all variants as a control group.
1 <= x <= 50Enable multi-armed bandit (Thompson) auto-optimization — traffic shifts toward leading variants mid-send instead of an even split.