> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Toggle Alarm

> Enable or disable an alarm.

### Headers

**authorization** `string` *required*

Your API key for authentication.

### Path Parameters

**id** `string` *required*

Alarm configuration ID.

### Body Parameters

**enabled** `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

**data.alarm** `object`

Updated alarm configuration object.

**data.alarm.enabled** `boolean`

Updated enabled state.

**data.alarm.id** `string`

Alarm configuration ID.

**data.alarm.metric\_type** `string`

Metric this alarm tracks.

**data.alarm.threshold** `number`

Configured threshold for this alarm.

**data.alarm.webhook\_config** `object|null`

Webhook settings object. Header values may be masked in responses.

**data.alarm.email\_addresses** `string[]`

Email recipients for notifications. Can be an empty array.

**data.alarm.sms\_numbers** `string[]`

SMS recipients for notifications. Can be an empty array.

**data.alarm.created\_at** `string`

ISO timestamp when the alarm was created.

**data.alarm.updated\_at** `string`

ISO timestamp when the alarm was last updated.

**errors** `null|array`

`null` on success, otherwise an array of error objects.

```json Success theme={null}
{
  "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
}
```

```json Error theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "INVALID_ENABLED_VALUE",
      "message": "enabled must be a boolean value (true or false)"
    }
  ]
}
```

***

Docs for agents: [llms.txt](https://docs.bland.ai/llms.txt)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.