Toggle Alarm
curl --request POST \
--url https://api.bland.ai/v1/alarms/{id}/toggle \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"enabled": true
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}/toggle"
payload = { "enabled": True }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true})
};
fetch('https://api.bland.ai/v1/alarms/{id}/toggle', 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}/toggle",
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([
'enabled' => true
]),
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}/toggle"
payload := strings.NewReader("{\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.bland.ai/v1/alarms/{id}/toggle")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}/toggle")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"alarm": {
"id": "72e424a6-496f-4f89-a349-c6c8cb3eff29",
"metric_type": "latency",
"enabled": false,
"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-12T17:08:56.928Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "INVALID_ENABLED_VALUE",
"message": "enabled must be a boolean value (true or false)"
}
]
}
Alarms
Toggle Alarm
Enable or disable an alarm.
POST
/
v1
/
alarms
/
{id}
/
toggle
Toggle Alarm
curl --request POST \
--url https://api.bland.ai/v1/alarms/{id}/toggle \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"enabled": true
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}/toggle"
payload = { "enabled": True }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true})
};
fetch('https://api.bland.ai/v1/alarms/{id}/toggle', 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}/toggle",
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([
'enabled' => true
]),
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}/toggle"
payload := strings.NewReader("{\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.bland.ai/v1/alarms/{id}/toggle")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}/toggle")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"alarm": {
"id": "72e424a6-496f-4f89-a349-c6c8cb3eff29",
"metric_type": "latency",
"enabled": false,
"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-12T17:08:56.928Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "INVALID_ENABLED_VALUE",
"message": "enabled must be a boolean value (true or false)"
}
]
}
Headers
string
required
Your API key for authentication.
Path Parameters
string
required
Alarm configuration ID.
Body Parameters
boolean
required
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.
Response
object
Updated alarm configuration object.
boolean
Updated enabled state.
string
Alarm configuration ID.
string
Metric this alarm tracks.
number
Configured threshold for this alarm.
object|null
Webhook settings object. Header values may be masked in responses.
string[]
Email recipients for notifications. Can be an empty array.
string[]
SMS recipients for notifications. Can be an empty array.
string
ISO timestamp when the alarm was created.
string
ISO timestamp when the alarm was last updated.
null|array
null on success, otherwise an array of error objects.{
"data": {
"alarm": {
"id": "72e424a6-496f-4f89-a349-c6c8cb3eff29",
"metric_type": "latency",
"enabled": false,
"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-12T17:08:56.928Z"
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "INVALID_ENABLED_VALUE",
"message": "enabled must be a boolean value (true or false)"
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I