Update Alarm
curl --request PATCH \
--url https://api.bland.ai/v1/alarms/{id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"threshold": 123,
"enabled": true,
"webhook_config": {},
"email_addresses": [
"<string>"
],
"sms_numbers": [
"<string>"
]
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}"
payload = {
"threshold": 123,
"enabled": True,
"webhook_config": {},
"email_addresses": ["<string>"],
"sms_numbers": ["<string>"]
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
threshold: 123,
enabled: true,
webhook_config: {},
email_addresses: ['<string>'],
sms_numbers: ['<string>']
})
};
fetch('https://api.bland.ai/v1/alarms/{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.bland.ai/v1/alarms/{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([
'threshold' => 123,
'enabled' => true,
'webhook_config' => [
],
'email_addresses' => [
'<string>'
],
'sms_numbers' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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.bland.ai/v1/alarms/{id}"
payload := strings.NewReader("{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("authorization", "<authorization>")
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.bland.ai/v1/alarms/{id}")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"alarm": {
"id": "d4cfd8aa-7df4-4fd7-a5cf-8c5d2871a1f8",
"metric_type": "latency",
"enabled": true,
"threshold": 0.5,
"webhook_config": {
"url": "https://example.com/webhooks/alarms",
"headers": {
"Content-Type": "appl***"
}
},
"email_addresses": ["alerts@example.com"],
"sms_numbers": [],
"created_at": "2026-03-12T16:13:02.694Z",
"updated_at": "2026-03-12T16:45:52.721Z"
}
},
"errors": null
}
Alarms
Update Alarm
Update an alarm configuration.
PATCH
/
v1
/
alarms
/
{id}
Update Alarm
curl --request PATCH \
--url https://api.bland.ai/v1/alarms/{id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"threshold": 123,
"enabled": true,
"webhook_config": {},
"email_addresses": [
"<string>"
],
"sms_numbers": [
"<string>"
]
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}"
payload = {
"threshold": 123,
"enabled": True,
"webhook_config": {},
"email_addresses": ["<string>"],
"sms_numbers": ["<string>"]
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
threshold: 123,
enabled: true,
webhook_config: {},
email_addresses: ['<string>'],
sms_numbers: ['<string>']
})
};
fetch('https://api.bland.ai/v1/alarms/{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.bland.ai/v1/alarms/{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([
'threshold' => 123,
'enabled' => true,
'webhook_config' => [
],
'email_addresses' => [
'<string>'
],
'sms_numbers' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$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.bland.ai/v1/alarms/{id}"
payload := strings.NewReader("{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("authorization", "<authorization>")
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.bland.ai/v1/alarms/{id}")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"threshold\": 123,\n \"enabled\": true,\n \"webhook_config\": {},\n \"email_addresses\": [\n \"<string>\"\n ],\n \"sms_numbers\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"alarm": {
"id": "d4cfd8aa-7df4-4fd7-a5cf-8c5d2871a1f8",
"metric_type": "latency",
"enabled": true,
"threshold": 0.5,
"webhook_config": {
"url": "https://example.com/webhooks/alarms",
"headers": {
"Content-Type": "appl***"
}
},
"email_addresses": ["alerts@example.com"],
"sms_numbers": [],
"created_at": "2026-03-12T16:13:02.694Z",
"updated_at": "2026-03-12T16:45:52.721Z"
}
},
"errors": null
}
Headers
string
required
Your API key for authentication.
Path Parameters
string
required
Alarm configuration ID.
Body Parameters
number
Updated positive numeric threshold.Notes:
thresholdis a sensitivity scalar (higher values are less sensitive; lower values are more sensitive).- The Dashboard may display an approximate ”% change” visualization for this value. Treat that UI percentage as a directional aid, not an exact conversion.
Sensitive→0.5Normal→1.0Relaxed→2.0Critical→2.5
boolean
Controls whether this alarm is actively evaluated.
true: Alarm is active. The system will evaluate this metric on scheduled runs and can generate alarm/recovery events and notifications.false: Alarm is paused. The config is retained, but scheduled evaluation and notifications for this alarm are disabled until re-enabled.
object|null
Updated webhook settings. Set to
null to clear.webhook_config should be a JSON object with:url(string, required when object is provided)headers(object, optional)
{
"webhook_config": {
"url": "https://example.com/webhooks/alarms",
"headers": {
"Content-Type": "application/json"
}
}
}
string[]
Updated email recipients.
string[]
Updated SMS recipients.
Response
object
Updated alarm configuration object.
object|null
Updated webhook settings object. Header values may be masked in API responses.
string[]
Updated email recipients. Can be an empty array if none are configured.
string[]
Updated SMS recipients. Can be an empty array if none are configured.
null|array
null on success, otherwise an array of error objects.{
"data": {
"alarm": {
"id": "d4cfd8aa-7df4-4fd7-a5cf-8c5d2871a1f8",
"metric_type": "latency",
"enabled": true,
"threshold": 0.5,
"webhook_config": {
"url": "https://example.com/webhooks/alarms",
"headers": {
"Content-Type": "appl***"
}
},
"email_addresses": ["alerts@example.com"],
"sms_numbers": [],
"created_at": "2026-03-12T16:13:02.694Z",
"updated_at": "2026-03-12T16:45:52.721Z"
}
},
"errors": null
}
Docs for agents: llms.txt
Was this page helpful?