Update a contact's preferences via a signed token
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/compliance/preferences/{token} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"frequencyPreference": "monthly",
"topicPreferences": {
"product_updates": "opted_out"
},
"requestDataDeletion": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}"
payload = {
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"frequencyPreference": "monthly",
"topicPreferences": { "product_updates": "opted_out" },
"requestDataDeletion": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelPreferences: {sms: 'opted_out', email: 'opted_in'},
frequencyPreference: 'monthly',
topicPreferences: {product_updates: 'opted_out'},
requestDataDeletion: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}', 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/compliance/preferences/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'channelPreferences' => [
'sms' => 'opted_out',
'email' => 'opted_in'
],
'frequencyPreference' => 'monthly',
'topicPreferences' => [
'product_updates' => 'opted_out'
],
'requestDataDeletion' => false
]),
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/compliance/preferences/{token}"
payload := strings.NewReader("{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"topicPreferences": {
"product_updates": "opted_out"
},
"frequencyPreference": "monthly",
"gdprRequest": null
},
"meta": {
"request_id": "req_1a2b3c4d5e6f",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}Compliance
Update a contact's preferences via a signed token
Public, no-auth endpoint that records a contact’s opt-in/opt-out choices from the hosted preference center. Given the signed token, it updates per-channel and per-topic subscription state and an optional send frequency, and can raise a GDPR deletion request. A global opt-out also writes the real-time STOP fence so in-flight campaign batches are suppressed immediately.
PUT
/
api
/
v1
/
compliance
/
preferences
/
{token}
Update a contact's preferences via a signed token
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/compliance/preferences/{token} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"frequencyPreference": "monthly",
"topicPreferences": {
"product_updates": "opted_out"
},
"requestDataDeletion": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}"
payload = {
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"frequencyPreference": "monthly",
"topicPreferences": { "product_updates": "opted_out" },
"requestDataDeletion": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelPreferences: {sms: 'opted_out', email: 'opted_in'},
frequencyPreference: 'monthly',
topicPreferences: {product_updates: 'opted_out'},
requestDataDeletion: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}', 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/compliance/preferences/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'channelPreferences' => [
'sms' => 'opted_out',
'email' => 'opted_in'
],
'frequencyPreference' => 'monthly',
'topicPreferences' => [
'product_updates' => 'opted_out'
],
'requestDataDeletion' => false
]),
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/compliance/preferences/{token}"
payload := strings.NewReader("{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/preferences/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelPreferences\": {\n \"sms\": \"opted_out\",\n \"email\": \"opted_in\"\n },\n \"frequencyPreference\": \"monthly\",\n \"topicPreferences\": {\n \"product_updates\": \"opted_out\"\n },\n \"requestDataDeletion\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"channelPreferences": {
"sms": "opted_out",
"email": "opted_in"
},
"topicPreferences": {
"product_updates": "opted_out"
},
"frequencyPreference": "monthly",
"gdprRequest": null
},
"meta": {
"request_id": "req_1a2b3c4d5e6f",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
The signed preference token from the preference-center link.
Body
application/json
Per-channel opt state; at least one channel is required.
Show child attributes
Show child attributes
Optional send-frequency preference.
Optional per-topic subscription state keyed by topic id.
Show child attributes
Show child attributes
Set true to raise a GDPR data-deletion request for this contact.
⌘I