curl --request POST \
--url https://api.orbit.devotel.io/api/v1/compliance/preference-center \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"headerText": "Communication Preferences",
"channels": [
"sms",
"email"
],
"showFrequencyOptions": true,
"showGdprDelete": true,
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": true
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/preference-center"
payload = {
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"headerText": "Communication Preferences",
"channels": ["sms", "email"],
"showFrequencyOptions": True,
"showGdprDelete": True,
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": True
}
]
}
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({
companyName: 'Acme Corp',
primaryColor: '#2563eb',
headerText: 'Communication Preferences',
channels: ['sms', 'email'],
showFrequencyOptions: true,
showGdprDelete: true,
topics: [{id: 'product-updates', name: 'Product updates', defaultOptIn: true}]
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/preference-center', 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/preference-center",
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([
'companyName' => 'Acme Corp',
'primaryColor' => '#2563eb',
'headerText' => 'Communication Preferences',
'channels' => [
'sms',
'email'
],
'showFrequencyOptions' => true,
'showGdprDelete' => true,
'topics' => [
[
'id' => 'product-updates',
'name' => 'Product updates',
'defaultOptIn' => true
]
]
]),
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/preference-center"
payload := strings.NewReader("{\n \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\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/compliance/preference-center")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/preference-center")
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 \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"channels": [
"sms",
"email"
],
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": true
}
]
},
"meta": {
"request_id": "req_1a2b3c4d5e6f",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}Create or update the preference-center configuration
Create or replace this tenant’s hosted preference-center configuration — the branding (company name, logo, colours, header/footer copy), the channels a contact may manage, the subscription topics, and the optional post-opt-out redirect. Call it from the compliance settings screen whenever an operator saves the setup; the stored config drives the public hosted page a contact opens from an unsubscribe link. Owner/admin only.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/compliance/preference-center \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"headerText": "Communication Preferences",
"channels": [
"sms",
"email"
],
"showFrequencyOptions": true,
"showGdprDelete": true,
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": true
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/preference-center"
payload = {
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"headerText": "Communication Preferences",
"channels": ["sms", "email"],
"showFrequencyOptions": True,
"showGdprDelete": True,
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": True
}
]
}
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({
companyName: 'Acme Corp',
primaryColor: '#2563eb',
headerText: 'Communication Preferences',
channels: ['sms', 'email'],
showFrequencyOptions: true,
showGdprDelete: true,
topics: [{id: 'product-updates', name: 'Product updates', defaultOptIn: true}]
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/preference-center', 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/preference-center",
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([
'companyName' => 'Acme Corp',
'primaryColor' => '#2563eb',
'headerText' => 'Communication Preferences',
'channels' => [
'sms',
'email'
],
'showFrequencyOptions' => true,
'showGdprDelete' => true,
'topics' => [
[
'id' => 'product-updates',
'name' => 'Product updates',
'defaultOptIn' => true
]
]
]),
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/preference-center"
payload := strings.NewReader("{\n \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\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/compliance/preference-center")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/preference-center")
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 \"companyName\": \"Acme Corp\",\n \"primaryColor\": \"#2563eb\",\n \"headerText\": \"Communication Preferences\",\n \"channels\": [\n \"sms\",\n \"email\"\n ],\n \"showFrequencyOptions\": true,\n \"showGdprDelete\": true,\n \"topics\": [\n {\n \"id\": \"product-updates\",\n \"name\": \"Product updates\",\n \"defaultOptIn\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"companyName": "Acme Corp",
"primaryColor": "#2563eb",
"channels": [
"sms",
"email"
],
"topics": [
{
"id": "product-updates",
"name": "Product updates",
"defaultOptIn": true
}
]
},
"meta": {
"request_id": "req_1a2b3c4d5e6f",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}Authorizations
Dashboard JWT token from Clerk
Body
Name shown on the hosted page.
Whether the hosted preference page is live.
Logo image URL (http/https only).
Brand colour as a 6-digit hex value (e.g. #2563eb).
Heading shown at the top of the page.
Footer copy shown beneath the preferences.
Channels a contact can opt in or out of.
Whether to show the send-frequency selector.
Whether to offer the "delete my data" action.
Optional URL to redirect to after opt-out (http/https only).
Subscription topics/groups the contact can manage.
Show child attributes
Show child attributes