Activate an ad-platform audience
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segment_id": "<string>",
"members": [
{
"email": "<string>",
"email_work": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"madid": "<string>"
}
],
"operation": "add"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}"
payload = {
"segment_id": "<string>",
"members": [
{
"email": "<string>",
"email_work": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"madid": "<string>"
}
],
"operation": "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({
segment_id: '<string>',
members: [
{
email: '<string>',
email_work: '<string>',
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>',
madid: '<string>'
}
],
operation: 'add'
})
};
fetch('https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}', 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/cdp/audience/activate/{platform}",
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([
'segment_id' => '<string>',
'members' => [
[
'email' => '<string>',
'email_work' => '<string>',
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>',
'madid' => '<string>'
]
],
'operation' => '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/cdp/audience/activate/{platform}"
payload := strings.NewReader("{\n \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"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/cdp/audience/activate/{platform}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}")
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 \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ts": "2023-11-07T05:31:56Z",
"segment_id": "<string>",
"requested": 123,
"matched": 123,
"skipped": 123,
"batches": 123,
"dispatched": 123,
"dispatch_skipped": 123,
"error": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}CDP
Activate an ad-platform audience
Builds the hashed-identifier upload payload (every PII identifier is SHA-256-hashed before it leaves the process — cleartext is never persisted, logged, or sent), batches it, and dispatches each batch to the ad network via Nango when a connection is wired. The run is appended to a capped activation history. Owner / admin / developer only.
POST
/
api
/
v1
/
cdp
/
audience
/
activate
/
{platform}
Activate an ad-platform audience
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segment_id": "<string>",
"members": [
{
"email": "<string>",
"email_work": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"madid": "<string>"
}
],
"operation": "add"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}"
payload = {
"segment_id": "<string>",
"members": [
{
"email": "<string>",
"email_work": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"madid": "<string>"
}
],
"operation": "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({
segment_id: '<string>',
members: [
{
email: '<string>',
email_work: '<string>',
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>',
madid: '<string>'
}
],
operation: 'add'
})
};
fetch('https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}', 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/cdp/audience/activate/{platform}",
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([
'segment_id' => '<string>',
'members' => [
[
'email' => '<string>',
'email_work' => '<string>',
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>',
'madid' => '<string>'
]
],
'operation' => '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/cdp/audience/activate/{platform}"
payload := strings.NewReader("{\n \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"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/cdp/audience/activate/{platform}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/audience/activate/{platform}")
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 \"segment_id\": \"<string>\",\n \"members\": [\n {\n \"email\": \"<string>\",\n \"email_work\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"madid\": \"<string>\"\n }\n ],\n \"operation\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ts": "2023-11-07T05:31:56Z",
"segment_id": "<string>",
"requested": 123,
"matched": 123,
"skipped": 123,
"batches": 123,
"dispatched": 123,
"dispatch_skipped": 123,
"error": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Available options:
facebook, google, tiktok, linkedin, snapchat, pinterest, reddit, the_trade_desk, criteo Body
application/json
Audience activation request. platform comes from the URL param and audience_id is resolved from the stored mapping, never the body.
⌘I