Bulk add or remove segment membership
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/bulk/segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
"contact_01HZX8Y7QJK4M"
],
"segment_id": "seg_01HZX8VIP",
"action": "add"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/bulk/segment"
payload = {
"contact_ids": ["contact_01HZX8Y7QJK4M"],
"segment_id": "seg_01HZX8VIP",
"action": "add"
}
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({
contact_ids: ['contact_01HZX8Y7QJK4M'],
segment_id: 'seg_01HZX8VIP',
action: 'add'
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/bulk/segment', 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/bulk/segment",
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([
'contact_ids' => [
'contact_01HZX8Y7QJK4M'
],
'segment_id' => 'seg_01HZX8VIP',
'action' => 'add'
]),
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/bulk/segment"
payload := strings.NewReader("{\n \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\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/bulk/segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/bulk/segment")
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 \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"queued": false,
"affected": 1,
"total": 1
},
"meta": {
"request_id": "req_01HZX9ABCDEF",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}{
"data": {
"queued": true,
"job_id": "bulkop_01HZX9QJK4M",
"total": 12000
},
"meta": {
"request_id": "req_01HZX9ABCDEF",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Contacts
Bulk add or remove segment membership
Add a selected audience to a static segment, or remove them from it, in a single request. Target the audience with either an explicit contact_ids array or a filters AST — provide exactly one. Membership changes emit the same contact.entered_segment / contact.exited_segment webhooks as the manual path. Large selections are queued and return a job id.
POST
/
api
/
v1
/
contacts
/
bulk
/
segment
Bulk add or remove segment membership
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/bulk/segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
"contact_01HZX8Y7QJK4M"
],
"segment_id": "seg_01HZX8VIP",
"action": "add"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/bulk/segment"
payload = {
"contact_ids": ["contact_01HZX8Y7QJK4M"],
"segment_id": "seg_01HZX8VIP",
"action": "add"
}
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({
contact_ids: ['contact_01HZX8Y7QJK4M'],
segment_id: 'seg_01HZX8VIP',
action: 'add'
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/bulk/segment', 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/bulk/segment",
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([
'contact_ids' => [
'contact_01HZX8Y7QJK4M'
],
'segment_id' => 'seg_01HZX8VIP',
'action' => 'add'
]),
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/bulk/segment"
payload := strings.NewReader("{\n \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\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/bulk/segment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/bulk/segment")
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 \"contact_ids\": [\n \"contact_01HZX8Y7QJK4M\"\n ],\n \"segment_id\": \"seg_01HZX8VIP\",\n \"action\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"queued": false,
"affected": 1,
"total": 1
},
"meta": {
"request_id": "req_01HZX9ABCDEF",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}{
"data": {
"queued": true,
"job_id": "bulkop_01HZX9QJK4M",
"total": 12000
},
"meta": {
"request_id": "req_01HZX9ABCDEF",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
The target segment to add contacts to or remove them from.
Whether to add the audience to the segment or remove it.
Available options:
add, remove Explicit contact ids to target (max 50,000). Provide this OR filters.
Segment filter AST resolving the audience server-side. Provide this OR contact_ids.
⌘I