curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "High-value EU customers",
"auto_refresh": true,
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments"
payload = {
"name": "High-value EU customers",
"auto_refresh": True,
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
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({
name: 'High-value EU customers',
auto_refresh: true,
filters: {
op: 'AND',
conditions: [
{field: 'lifecycle_stage', op: 'equals', value: 'customer'},
{field: 'country_code', op: 'equals', value: 'DE'}
]
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments', 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/contacts/segments",
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([
'name' => 'High-value EU customers',
'auto_refresh' => true,
'filters' => [
'op' => 'AND',
'conditions' => [
[
'field' => 'lifecycle_stage',
'op' => 'equals',
'value' => 'customer'
],
[
'field' => 'country_code',
'op' => 'equals',
'value' => 'DE'
]
]
]
]),
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/contacts/segments"
payload := strings.NewReader("{\n \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\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/contacts/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments")
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 \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}{
"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>"
}
}Create a contact segment
Create a new contact segment from either the filters AST (AND/OR groups of conditions) or the legacy rules shape, with an optional auto_refresh flag (default true) and per-segment cadence. When a rule definition is supplied the membership is materialised inline — so the segment’s contact count and members are live immediately, without waiting for the refresh scheduler. Returns 201 with the created, already-materialised segment.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "High-value EU customers",
"auto_refresh": true,
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments"
payload = {
"name": "High-value EU customers",
"auto_refresh": True,
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
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({
name: 'High-value EU customers',
auto_refresh: true,
filters: {
op: 'AND',
conditions: [
{field: 'lifecycle_stage', op: 'equals', value: 'customer'},
{field: 'country_code', op: 'equals', value: 'DE'}
]
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments', 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/contacts/segments",
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([
'name' => 'High-value EU customers',
'auto_refresh' => true,
'filters' => [
'op' => 'AND',
'conditions' => [
[
'field' => 'lifecycle_stage',
'op' => 'equals',
'value' => 'customer'
],
[
'field' => 'country_code',
'op' => 'equals',
'value' => 'DE'
]
]
]
]),
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/contacts/segments"
payload := strings.NewReader("{\n \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\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/contacts/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments")
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 \"name\": \"High-value EU customers\",\n \"auto_refresh\": true,\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}{
"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
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.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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.
true, false Body
Display name (1-200 chars).
Optional description (up to 1000 chars).
AND/OR filter AST that defines the segment's membership.
Legacy { operator, conditions } rule shape, still accepted for backwards compatibility.
Whether the scheduler re-materialises membership automatically.
Per-segment refresh cadence in minutes (1-1440).