curl --request POST \
--url https://api.orbit.devotel.io/api/v1/compliance/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "BXYZ123",
"usecase": "MARKETING",
"description": "Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.",
"sample_message": [
"Your Acme order #1234 has shipped. Reply STOP to opt out."
],
"message_flow": "Customers opt in at checkout by checking the SMS updates box.",
"help_message": "Acme Rewards: reply STOP to unsubscribe or email help@acme.example.",
"optout_message": "You have been unsubscribed from Acme Rewards and will receive no further messages."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/campaigns"
payload = {
"brand_id": "BXYZ123",
"usecase": "MARKETING",
"description": "Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.",
"sample_message": ["Your Acme order #1234 has shipped. Reply STOP to opt out."],
"message_flow": "Customers opt in at checkout by checking the SMS updates box.",
"help_message": "Acme Rewards: reply STOP to unsubscribe or email help@acme.example.",
"optout_message": "You have been unsubscribed from Acme Rewards and will receive no further messages."
}
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({
brand_id: 'BXYZ123',
usecase: 'MARKETING',
description: 'Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.',
sample_message: ['Your Acme order #1234 has shipped. Reply STOP to opt out.'],
message_flow: 'Customers opt in at checkout by checking the SMS updates box.',
help_message: 'Acme Rewards: reply STOP to unsubscribe or email help@acme.example.',
optout_message: 'You have been unsubscribed from Acme Rewards and will receive no further messages.'
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/campaigns', 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/campaigns",
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([
'brand_id' => 'BXYZ123',
'usecase' => 'MARKETING',
'description' => 'Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.',
'sample_message' => [
'Your Acme order #1234 has shipped. Reply STOP to opt out.'
],
'message_flow' => 'Customers opt in at checkout by checking the SMS updates box.',
'help_message' => 'Acme Rewards: reply STOP to unsubscribe or email help@acme.example.',
'optout_message' => 'You have been unsubscribed from Acme Rewards and will receive no further messages.'
]),
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/campaigns"
payload := strings.NewReader("{\n \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\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/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/campaigns")
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 \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaignId": "CABC456",
"status": "PENDING"
},
"meta": {
"request_id": "req_9s8d7f6g5h4j",
"timestamp": "2026-08-07T12:34:56.000Z"
}
}Register a 10DLC campaign under a brand
Registers a US A2P 10DLC campaign under an already-registered brand. Supply the target brand_id, the use case, a description, sample messages, and the opt-in/help/opt-out language carriers require; the campaign is submitted to The Campaign Registry for CSP and per-MNO review. Political use cases must include a Campaign Verify cv_token. Owner/admin only.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/compliance/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": "BXYZ123",
"usecase": "MARKETING",
"description": "Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.",
"sample_message": [
"Your Acme order #1234 has shipped. Reply STOP to opt out."
],
"message_flow": "Customers opt in at checkout by checking the SMS updates box.",
"help_message": "Acme Rewards: reply STOP to unsubscribe or email help@acme.example.",
"optout_message": "You have been unsubscribed from Acme Rewards and will receive no further messages."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/compliance/campaigns"
payload = {
"brand_id": "BXYZ123",
"usecase": "MARKETING",
"description": "Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.",
"sample_message": ["Your Acme order #1234 has shipped. Reply STOP to opt out."],
"message_flow": "Customers opt in at checkout by checking the SMS updates box.",
"help_message": "Acme Rewards: reply STOP to unsubscribe or email help@acme.example.",
"optout_message": "You have been unsubscribed from Acme Rewards and will receive no further messages."
}
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({
brand_id: 'BXYZ123',
usecase: 'MARKETING',
description: 'Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.',
sample_message: ['Your Acme order #1234 has shipped. Reply STOP to opt out.'],
message_flow: 'Customers opt in at checkout by checking the SMS updates box.',
help_message: 'Acme Rewards: reply STOP to unsubscribe or email help@acme.example.',
optout_message: 'You have been unsubscribed from Acme Rewards and will receive no further messages.'
})
};
fetch('https://api.orbit.devotel.io/api/v1/compliance/campaigns', 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/campaigns",
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([
'brand_id' => 'BXYZ123',
'usecase' => 'MARKETING',
'description' => 'Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.',
'sample_message' => [
'Your Acme order #1234 has shipped. Reply STOP to opt out.'
],
'message_flow' => 'Customers opt in at checkout by checking the SMS updates box.',
'help_message' => 'Acme Rewards: reply STOP to unsubscribe or email help@acme.example.',
'optout_message' => 'You have been unsubscribed from Acme Rewards and will receive no further messages.'
]),
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/campaigns"
payload := strings.NewReader("{\n \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\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/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/compliance/campaigns")
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 \"brand_id\": \"BXYZ123\",\n \"usecase\": \"MARKETING\",\n \"description\": \"Order updates and loyalty rewards notifications for Acme Rewards members who opted in at checkout.\",\n \"sample_message\": [\n \"Your Acme order #1234 has shipped. Reply STOP to opt out.\"\n ],\n \"message_flow\": \"Customers opt in at checkout by checking the SMS updates box.\",\n \"help_message\": \"Acme Rewards: reply STOP to unsubscribe or email help@acme.example.\",\n \"optout_message\": \"You have been unsubscribed from Acme Rewards and will receive no further messages.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaignId": "CABC456",
"status": "PENDING"
},
"meta": {
"request_id": "req_9s8d7f6g5h4j",
"timestamp": "2026-08-07T12:34:56.000Z"
}
}Authorizations
Dashboard JWT token from Clerk
Body
Registrar brand id the campaign is registered under.
What the campaign sends and to whom (40–4096 chars).
40 - 4096Representative sample messages (1–10).
1 - 10 elementsHow recipients opt in to the campaign.
Reply sent to HELP requests.
Reply sent to STOP/opt-out requests.
Campaign use case (e.g. MIXED, MARKETING, POLITICAL_ADVOCACY).
Set when the campaign is a political use case.
Campaign Verify JWT — required for political campaigns.