Send RCS catalog carousel
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "+14155550123",
"product_ids": [
"SKU-1042",
"SKU-1043",
"SKU-1071"
],
"body": "Back in stock — three picks we saved for you.",
"checkout_url": "https://shop.example.com/cart",
"card_width": "MEDIUM",
"add_to_cart_label": "Add to cart",
"checkout_label": "Checkout"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog"
payload = {
"to": "+14155550123",
"product_ids": ["SKU-1042", "SKU-1043", "SKU-1071"],
"body": "Back in stock — three picks we saved for you.",
"checkout_url": "https://shop.example.com/cart",
"card_width": "MEDIUM",
"add_to_cart_label": "Add to cart",
"checkout_label": "Checkout"
}
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({
to: '+14155550123',
product_ids: ['SKU-1042', 'SKU-1043', 'SKU-1071'],
body: JSON.stringify('Back in stock — three picks we saved for you.'),
checkout_url: 'https://shop.example.com/cart',
card_width: 'MEDIUM',
add_to_cart_label: 'Add to cart',
checkout_label: 'Checkout'
})
};
fetch('https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog', 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/commerce/send-catalog",
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([
'to' => '+14155550123',
'product_ids' => [
'SKU-1042',
'SKU-1043',
'SKU-1071'
],
'body' => 'Back in stock — three picks we saved for you.',
'checkout_url' => 'https://shop.example.com/cart',
'card_width' => 'MEDIUM',
'add_to_cart_label' => 'Add to cart',
'checkout_label' => 'Checkout'
]),
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/commerce/send-catalog"
payload := strings.NewReader("{\n \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\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/commerce/send-catalog")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog")
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 \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\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
Send RCS catalog carousel
Render catalog products into an RCS rich-card carousel with add-to-cart and checkout suggested actions, and send it to one recipient through the standard message pipeline (billing, delivery receipts, and rate limits all apply unchanged). Omit product_ids to send the whole catalog — the renderer caps it at the RBM carousel ceiling. At least two usable products are required; fewer returns a validation error. Use it to turn a product list into a shoppable conversation.
POST
/
api
/
v1
/
rcs
/
commerce
/
send-catalog
Send RCS catalog carousel
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "+14155550123",
"product_ids": [
"SKU-1042",
"SKU-1043",
"SKU-1071"
],
"body": "Back in stock — three picks we saved for you.",
"checkout_url": "https://shop.example.com/cart",
"card_width": "MEDIUM",
"add_to_cart_label": "Add to cart",
"checkout_label": "Checkout"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog"
payload = {
"to": "+14155550123",
"product_ids": ["SKU-1042", "SKU-1043", "SKU-1071"],
"body": "Back in stock — three picks we saved for you.",
"checkout_url": "https://shop.example.com/cart",
"card_width": "MEDIUM",
"add_to_cart_label": "Add to cart",
"checkout_label": "Checkout"
}
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({
to: '+14155550123',
product_ids: ['SKU-1042', 'SKU-1043', 'SKU-1071'],
body: JSON.stringify('Back in stock — three picks we saved for you.'),
checkout_url: 'https://shop.example.com/cart',
card_width: 'MEDIUM',
add_to_cart_label: 'Add to cart',
checkout_label: 'Checkout'
})
};
fetch('https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog', 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/commerce/send-catalog",
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([
'to' => '+14155550123',
'product_ids' => [
'SKU-1042',
'SKU-1043',
'SKU-1071'
],
'body' => 'Back in stock — three picks we saved for you.',
'checkout_url' => 'https://shop.example.com/cart',
'card_width' => 'MEDIUM',
'add_to_cart_label' => 'Add to cart',
'checkout_label' => 'Checkout'
]),
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/commerce/send-catalog"
payload := strings.NewReader("{\n \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\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/commerce/send-catalog")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/rcs/commerce/send-catalog")
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 \"to\": \"+14155550123\",\n \"product_ids\": [\n \"SKU-1042\",\n \"SKU-1043\",\n \"SKU-1071\"\n ],\n \"body\": \"Back in stock — three picks we saved for you.\",\n \"checkout_url\": \"https://shop.example.com/cart\",\n \"card_width\": \"MEDIUM\",\n \"add_to_cart_label\": \"Add to cart\",\n \"checkout_label\": \"Checkout\"\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
Recipient phone number in E.164 format.
Required string length:
3 - 40Catalog product (retailer) ids to include. Omit to use the whole catalog.
Maximum array length:
50Required string length:
1 - 256Optional message text rendered above the carousel.
Maximum string length:
2000HTTPS URL opened by the message-level checkout suggested action.
Carousel card width.
Available options:
SMALL, MEDIUM Override label for the per-card add-to-cart suggested action.
Required string length:
1 - 25Override label for the message-level checkout suggested action.
Required string length:
1 - 25Response
The queued carousel message (id, status, channel) wrapped in the standard { data, meta } envelope. Delivery is asynchronous — track it with the message status webhooks.
The queued carousel message (id, status, channel) wrapped in the standard { data, meta } envelope. Delivery is asynchronous — track it with the message status webhooks.