curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"contact": "+14155550142",
"channel": "sms",
"reason": "Suppression list import"
},
{
"contact": "grace@example.com",
"channel": "email",
"reason": "Unsubscribed"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk"
payload = { "rows": [
{
"contact": "+14155550142",
"channel": "sms",
"reason": "Suppression list import"
},
{
"contact": "grace@example.com",
"channel": "email",
"reason": "Unsubscribed"
}
] }
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({
rows: [
{contact: '+14155550142', channel: 'sms', reason: 'Suppression list import'},
{contact: 'grace@example.com', channel: 'email', reason: 'Unsubscribed'}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk', 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/contacts/optouts/bulk",
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([
'rows' => [
[
'contact' => '+14155550142',
'channel' => 'sms',
'reason' => 'Suppression list import'
],
[
'contact' => 'grace@example.com',
'channel' => 'email',
'reason' => 'Unsubscribed'
]
]
]),
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/contacts/optouts/bulk"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\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/contacts/optouts/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk")
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 \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"total": 123,
"succeeded": 123,
"skipped": 123,
"failed": 123,
"results": [
{}
]
},
"meta": {}
}{
"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>"
}
}Bulk opt contacts out
Suppress up to 500 contacts in one request — the batched path behind the suppression-file (CSV) import wizard. Each row is processed independently, so successes, already-suppressed skips and per-row failures are isolated and one bad row never fails the batch. Returns HTTP 207 with a { total, succeeded, skipped, failed, results[] } summary carrying an actionable per-row status and error message.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"contact": "+14155550142",
"channel": "sms",
"reason": "Suppression list import"
},
{
"contact": "grace@example.com",
"channel": "email",
"reason": "Unsubscribed"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk"
payload = { "rows": [
{
"contact": "+14155550142",
"channel": "sms",
"reason": "Suppression list import"
},
{
"contact": "grace@example.com",
"channel": "email",
"reason": "Unsubscribed"
}
] }
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({
rows: [
{contact: '+14155550142', channel: 'sms', reason: 'Suppression list import'},
{contact: 'grace@example.com', channel: 'email', reason: 'Unsubscribed'}
]
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk', 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/contacts/optouts/bulk",
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([
'rows' => [
[
'contact' => '+14155550142',
'channel' => 'sms',
'reason' => 'Suppression list import'
],
[
'contact' => 'grace@example.com',
'channel' => 'email',
'reason' => 'Unsubscribed'
]
]
]),
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/contacts/optouts/bulk"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\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/contacts/optouts/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/optouts/bulk")
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 \"rows\": [\n {\n \"contact\": \"+14155550142\",\n \"channel\": \"sms\",\n \"reason\": \"Suppression list import\"\n },\n {\n \"contact\": \"grace@example.com\",\n \"channel\": \"email\",\n \"reason\": \"Unsubscribed\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"total": 123,
"succeeded": 123,
"skipped": 123,
"failed": 123,
"results": [
{}
]
},
"meta": {}
}{
"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
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.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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.
true, false Body
Opt-out rows (1-500 — chunk larger suppression files client-side).
1 - 500 elementsShow child attributes
Show child attributes
Response
Per-row multi-status result: batch counters plus a results[] array with each row's status (succeeded / skipped / failed) and any error message.