curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queue_id": "<string>",
"name": "<string>",
"threshold": 123,
"duration_seconds": 43200,
"enabled": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}"
payload = {
"queue_id": "<string>",
"name": "<string>",
"threshold": 123,
"duration_seconds": 43200,
"enabled": True
}
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({
queue_id: '<string>',
name: '<string>',
threshold: 123,
duration_seconds: 43200,
enabled: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}', 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/voice/wallboard/alarm-rules/{ruleId}",
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([
'queue_id' => '<string>',
'name' => '<string>',
'threshold' => 123,
'duration_seconds' => 43200,
'enabled' => true
]),
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/voice/wallboard/alarm-rules/{ruleId}"
payload := strings.NewReader("{\n \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\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/voice/wallboard/alarm-rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}")
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 \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"name": "<string>",
"metric": "waiting",
"comparator": "gt",
"threshold": 123,
"duration_seconds": 43200,
"channel": "sse",
"enabled": true,
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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 a wallboard alarm rule
Updates an existing wallboard alarm rule. At least one field is required; send queue_id as null to make the rule tenant-wide. Returns 404 when the id is unknown; 409 when the new shape collides with another rule. Scoped on voice:write.
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queue_id": "<string>",
"name": "<string>",
"threshold": 123,
"duration_seconds": 43200,
"enabled": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}"
payload = {
"queue_id": "<string>",
"name": "<string>",
"threshold": 123,
"duration_seconds": 43200,
"enabled": True
}
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({
queue_id: '<string>',
name: '<string>',
threshold: 123,
duration_seconds: 43200,
enabled: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}', 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/voice/wallboard/alarm-rules/{ruleId}",
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([
'queue_id' => '<string>',
'name' => '<string>',
'threshold' => 123,
'duration_seconds' => 43200,
'enabled' => true
]),
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/voice/wallboard/alarm-rules/{ruleId}"
payload := strings.NewReader("{\n \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\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/voice/wallboard/alarm-rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/wallboard/alarm-rules/{ruleId}")
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 \"queue_id\": \"<string>\",\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"duration_seconds\": 43200,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"name": "<string>",
"metric": "waiting",
"comparator": "gt",
"threshold": 123,
"duration_seconds": 43200,
"channel": "sse",
"enabled": true,
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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 — 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 Path Parameters
Rule id (wbalarm_*).
1Body
At least one field required (queue_id / name / metric / comparator / threshold / duration_seconds / channel / enabled).
At least one field required (queue_id / name / metric / comparator / threshold / duration_seconds / channel / enabled).
Queue scope. Omitted or null = tenant-wide rule applying to every queue.
11 - 120waiting, longest_wait, avg_wait, predicted_wait, agents_available, agents_total, service_level, abandoned_rate gt, gte, lt, lte, eq Sustained breach window in seconds — 0 fires on the first breaching tick.
0 <= x <= 86400sse, sse+notification, webhook, email