curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"stop_keywords": [
"STOP",
"STOPALL",
"UNSUBSCRIBE",
"QUIT"
],
"stop_response": "You have been unsubscribed from Acme alerts. Reply START to rejoin.",
"brand": "acme"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}"
payload = {
"stop_keywords": ["STOP", "STOPALL", "UNSUBSCRIBE", "QUIT"],
"stop_response": "You have been unsubscribed from Acme alerts. Reply START to rejoin.",
"brand": "acme"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
stop_keywords: ['STOP', 'STOPALL', 'UNSUBSCRIBE', 'QUIT'],
stop_response: 'You have been unsubscribed from Acme alerts. Reply START to rejoin.',
brand: 'acme'
})
};
fetch('https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}', 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/messaging/opt-out-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stop_keywords' => [
'STOP',
'STOPALL',
'UNSUBSCRIBE',
'QUIT'
],
'stop_response' => 'You have been unsubscribed from Acme alerts. Reply START to rejoin.',
'brand' => 'acme'
]),
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/messaging/opt-out-lists/{id}"
payload := strings.NewReader("{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\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>"
}
}Update opt-out list
Update mutable fields on an opt-out list in place — send only the fields you want to change and at least one is required, so an empty body returns 422. Nullable fields (the three response texts, default_lang, brand) accept null to clear them; keyword arrays replace wholesale, so pass the full intended set. Changes take effect on the next inbound keyword match through the messaging services that reference this list. Owner / admin only; returns 404 when the id is not an opt-out list in this tenant and 409 when the new label collides with an active list.
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"stop_keywords": [
"STOP",
"STOPALL",
"UNSUBSCRIBE",
"QUIT"
],
"stop_response": "You have been unsubscribed from Acme alerts. Reply START to rejoin.",
"brand": "acme"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}"
payload = {
"stop_keywords": ["STOP", "STOPALL", "UNSUBSCRIBE", "QUIT"],
"stop_response": "You have been unsubscribed from Acme alerts. Reply START to rejoin.",
"brand": "acme"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
stop_keywords: ['STOP', 'STOPALL', 'UNSUBSCRIBE', 'QUIT'],
stop_response: 'You have been unsubscribed from Acme alerts. Reply START to rejoin.',
brand: 'acme'
})
};
fetch('https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}', 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/messaging/opt-out-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stop_keywords' => [
'STOP',
'STOPALL',
'UNSUBSCRIBE',
'QUIT'
],
'stop_response' => 'You have been unsubscribed from Acme alerts. Reply START to rejoin.',
'brand' => 'acme'
]),
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/messaging/opt-out-lists/{id}"
payload := strings.NewReader("{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/messaging/opt-out-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stop_keywords\": [\n \"STOP\",\n \"STOPALL\",\n \"UNSUBSCRIBE\",\n \"QUIT\"\n ],\n \"stop_response\": \"You have been unsubscribed from Acme alerts. Reply START to rejoin.\",\n \"brand\": \"acme\"\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
Dashboard JWT token from Clerk
Headers
Sandbox 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.
true, false Path Parameters
Body
Response
The updated opt-out list with its full keyword and response-copy configuration, wrapped in the standard { data, meta } envelope.
The updated opt-out list with its full keyword and response-copy configuration, wrapped in the standard { data, meta } envelope.