Create RCS brand
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/rcs/brands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_name": "Acme Retail",
"brand_website": "https://acme.example.com",
"brand_logo_url": "https://acme.example.com/logo.png",
"industry_vertical": "Retail",
"contact_first_name": "Ava",
"contact_last_name": "Thompson",
"contact_email": "ava@acme.example.com",
"contact_phone": "+15550123456",
"address_line_1": "100 Market St",
"city": "San Francisco",
"state_province": "CA",
"country": "US",
"postal_code": "94105"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/rcs/brands"
payload = {
"brand_name": "Acme Retail",
"brand_website": "https://acme.example.com",
"brand_logo_url": "https://acme.example.com/logo.png",
"industry_vertical": "Retail",
"contact_first_name": "Ava",
"contact_last_name": "Thompson",
"contact_email": "ava@acme.example.com",
"contact_phone": "+15550123456",
"address_line_1": "100 Market St",
"city": "San Francisco",
"state_province": "CA",
"country": "US",
"postal_code": "94105"
}
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_name: 'Acme Retail',
brand_website: 'https://acme.example.com',
brand_logo_url: 'https://acme.example.com/logo.png',
industry_vertical: 'Retail',
contact_first_name: 'Ava',
contact_last_name: 'Thompson',
contact_email: 'ava@acme.example.com',
contact_phone: '+15550123456',
address_line_1: '100 Market St',
city: 'San Francisco',
state_province: 'CA',
country: 'US',
postal_code: '94105'
})
};
fetch('https://api.orbit.devotel.io/api/v1/rcs/brands', 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/rcs/brands",
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_name' => 'Acme Retail',
'brand_website' => 'https://acme.example.com',
'brand_logo_url' => 'https://acme.example.com/logo.png',
'industry_vertical' => 'Retail',
'contact_first_name' => 'Ava',
'contact_last_name' => 'Thompson',
'contact_email' => 'ava@acme.example.com',
'contact_phone' => '+15550123456',
'address_line_1' => '100 Market St',
'city' => 'San Francisco',
'state_province' => 'CA',
'country' => 'US',
'postal_code' => '94105'
]),
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/rcs/brands"
payload := strings.NewReader("{\n \"brand_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\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/rcs/brands")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/rcs/brands")
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_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}RCS
Create RCS brand
Register a new RCS brand in draft status. A brand carries the identity and KYC details carriers ask for before they let a bot message their subscribers — brand name, website, logo, industry vertical, a contact person with email and phone, the postal address, and optionally a tax id or legal entity name. Creating a brand does not start the review; patch it until it is complete, then submit it. Returns 201 with the stored brand, or 422 listing the fields that failed validation.
POST
/
api
/
v1
/
rcs
/
brands
Create RCS brand
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/rcs/brands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_name": "Acme Retail",
"brand_website": "https://acme.example.com",
"brand_logo_url": "https://acme.example.com/logo.png",
"industry_vertical": "Retail",
"contact_first_name": "Ava",
"contact_last_name": "Thompson",
"contact_email": "ava@acme.example.com",
"contact_phone": "+15550123456",
"address_line_1": "100 Market St",
"city": "San Francisco",
"state_province": "CA",
"country": "US",
"postal_code": "94105"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/rcs/brands"
payload = {
"brand_name": "Acme Retail",
"brand_website": "https://acme.example.com",
"brand_logo_url": "https://acme.example.com/logo.png",
"industry_vertical": "Retail",
"contact_first_name": "Ava",
"contact_last_name": "Thompson",
"contact_email": "ava@acme.example.com",
"contact_phone": "+15550123456",
"address_line_1": "100 Market St",
"city": "San Francisco",
"state_province": "CA",
"country": "US",
"postal_code": "94105"
}
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_name: 'Acme Retail',
brand_website: 'https://acme.example.com',
brand_logo_url: 'https://acme.example.com/logo.png',
industry_vertical: 'Retail',
contact_first_name: 'Ava',
contact_last_name: 'Thompson',
contact_email: 'ava@acme.example.com',
contact_phone: '+15550123456',
address_line_1: '100 Market St',
city: 'San Francisco',
state_province: 'CA',
country: 'US',
postal_code: '94105'
})
};
fetch('https://api.orbit.devotel.io/api/v1/rcs/brands', 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/rcs/brands",
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_name' => 'Acme Retail',
'brand_website' => 'https://acme.example.com',
'brand_logo_url' => 'https://acme.example.com/logo.png',
'industry_vertical' => 'Retail',
'contact_first_name' => 'Ava',
'contact_last_name' => 'Thompson',
'contact_email' => 'ava@acme.example.com',
'contact_phone' => '+15550123456',
'address_line_1' => '100 Market St',
'city' => 'San Francisco',
'state_province' => 'CA',
'country' => 'US',
'postal_code' => '94105'
]),
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/rcs/brands"
payload := strings.NewReader("{\n \"brand_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\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/rcs/brands")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/rcs/brands")
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_name\": \"Acme Retail\",\n \"brand_website\": \"https://acme.example.com\",\n \"brand_logo_url\": \"https://acme.example.com/logo.png\",\n \"industry_vertical\": \"Retail\",\n \"contact_first_name\": \"Ava\",\n \"contact_last_name\": \"Thompson\",\n \"contact_email\": \"ava@acme.example.com\",\n \"contact_phone\": \"+15550123456\",\n \"address_line_1\": \"100 Market St\",\n \"city\": \"San Francisco\",\n \"state_province\": \"CA\",\n \"country\": \"US\",\n \"postal_code\": \"94105\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
The body is of type object.
Response
The newly created brand in draft status, wrapped in the standard { data, meta } envelope. data.id is the brand id you pass to the read, update, submit and delete endpoints.
The newly created brand in draft status, wrapped in the standard { data, meta } envelope. data.id is the brand id you pass to the read, update, submit and delete endpoints.