curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"threshold": 123,
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": true,
"cooldown_seconds": 43200
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-rules/{ruleId}"
payload = {
"name": "<string>",
"threshold": 123,
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": True,
"cooldown_seconds": 43200
}
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({
name: '<string>',
threshold: 123,
delivery_config: {webhook_event_type: '<string>', email_subject_prefix: '<string>'},
enabled: true,
cooldown_seconds: 43200
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-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/queues/{id}/alert-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([
'name' => '<string>',
'threshold' => 123,
'delivery_config' => [
'webhook_event_type' => '<string>',
'email_subject_prefix' => '<string>'
],
'enabled' => true,
'cooldown_seconds' => 43200
]),
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/queues/{id}/alert-rules/{ruleId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\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/queues/{id}/alert-rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-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 \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"queue_id": "<string>",
"name": "<string>",
"metric": "queue_depth",
"op": "gt",
"threshold": 123,
"action": "sse",
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": true,
"cooldown_seconds": 43200,
"last_fired_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "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 per-queue alert rule
Partially updates one alert rule — any subset of name / metric / op / threshold / action / delivery_config / enabled / cooldown_seconds. PATCH body must contain at least one field.
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"threshold": 123,
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": true,
"cooldown_seconds": 43200
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-rules/{ruleId}"
payload = {
"name": "<string>",
"threshold": 123,
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": True,
"cooldown_seconds": 43200
}
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({
name: '<string>',
threshold: 123,
delivery_config: {webhook_event_type: '<string>', email_subject_prefix: '<string>'},
enabled: true,
cooldown_seconds: 43200
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-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/queues/{id}/alert-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([
'name' => '<string>',
'threshold' => 123,
'delivery_config' => [
'webhook_event_type' => '<string>',
'email_subject_prefix' => '<string>'
],
'enabled' => true,
'cooldown_seconds' => 43200
]),
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/queues/{id}/alert-rules/{ruleId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\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/queues/{id}/alert-rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/queues/{id}/alert-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 \"name\": \"<string>\",\n \"threshold\": 123,\n \"delivery_config\": {\n \"webhook_event_type\": \"<string>\",\n \"email_subject_prefix\": \"<string>\"\n },\n \"enabled\": true,\n \"cooldown_seconds\": 43200\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"queue_id": "<string>",
"name": "<string>",
"metric": "queue_depth",
"op": "gt",
"threshold": 123,
"action": "sse",
"delivery_config": {
"webhook_event_type": "<string>",
"email_subject_prefix": "<string>"
},
"enabled": true,
"cooldown_seconds": 43200,
"last_fired_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "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. 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
Queue id (que_*).
1Rule id (qalert_*).
1Body
At least one field required (name / metric / op / threshold / action / delivery_config / enabled / cooldown_seconds).
At least one field required (name / metric / op / threshold / action / delivery_config / enabled / cooldown_seconds).
1 - 120queue_depth, asa_seconds, abandon_rate, sla_pct, aht_seconds, occupancy_pct, agents_available gt, gte, lt, lte sse, webhook, email Per-action delivery tunables. webhook_event_type overrides the outbound webhook event slug (default queue.alert_rule_fired); email_subject_prefix prepends an operator-visible prefix to the notification subject.
Show child attributes
Show child attributes
Re-fire suppression window in seconds. 0 disables the gate (legacy fire-every-tick).
0 <= x <= 86400Response
Successful response.
Show child attributes
Show child attributes