> ## 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

<ParamField header="authorization" type="string" required>
  Your API key for authentication.
</ParamField>

### Path Parameters

<ParamField path="id" type="string" required>
  Alarm configuration ID.
</ParamField>

### Body Parameters

<ParamField body="enabled" type="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.
</ParamField>

### Response

<ResponseField name="data.alarm" type="object">
  Updated alarm configuration object.
</ResponseField>

<ResponseField name="data.alarm.enabled" type="boolean">
  Updated enabled state.
</ResponseField>

<ResponseField name="data.alarm.id" type="string">
  Alarm configuration ID.
</ResponseField>

<ResponseField name="data.alarm.metric_type" type="string">
  Metric this alarm tracks.
</ResponseField>

<ResponseField name="data.alarm.threshold" type="number">
  Configured threshold for this alarm.
</ResponseField>

<ResponseField name="data.alarm.webhook_config" type="object|null">
  Webhook settings object. Header values may be masked in responses.
</ResponseField>

<ResponseField name="data.alarm.email_addresses" type="string[]">
  Email recipients for notifications. Can be an empty array.
</ResponseField>

<ResponseField name="data.alarm.sms_numbers" type="string[]">
  SMS recipients for notifications. Can be an empty array.
</ResponseField>

<ResponseField name="data.alarm.created_at" type="string">
  ISO timestamp when the alarm was created.
</ResponseField>

<ResponseField name="data.alarm.updated_at" type="string">
  ISO timestamp when the alarm was last updated.
</ResponseField>

<ResponseField name="errors" type="null|array">
  `null` on success, otherwise an array of error objects.
</ResponseField>

<ResponseExample>
  ```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)"
      }
    ]
  }
  ```
</ResponseExample>

***

Docs for agents: [llms.txt](/llms.txt)