---
title: "Update fields on an alert rule (enabled, threshold, channels, etc)"
method: POST
path: "/api/v1/update_alert_rule"
tags: ["Automation"]
---

# Update fields on an alert rule (enabled, threshold, channels, etc)

`POST /api/v1/update_alert_rule`

## Request

- Base URL: `https://api.pymaia.com`
- URL: `https://api.pymaia.com/api/v1/update_alert_rule`
- Auth: HTTP bearer

Update fields on an alert rule (enabled, threshold, channels, etc). Omit fields you do not want to change. Scoped to the current org.

## Request body

- object
  - `rule_id` string, required
  - `name` string
  - `description` string
  - `threshold` number
  - `condition` 'gt' | 'gte' | 'lt' | 'lte' | '%change_up' | '%change_down'
  - `comparison_period` 'day' | 'week' | 'month'
  - `enabled` boolean
  - `channels` string[]

## Response `200`

Tool executed successfully

- object
  - `ok` boolean
  - `result` unknown
  - `duration_ms` number

## Other responses

- `400`: Invalid params or handler error
- `401`: Missing or invalid Bearer token
- `403`: Missing required scope(s) (`denied_scope`), or the tool's module is disabled for the organization (`module_disabled`, with `why`, `fix` and `module`)
- `404`: Tool not found, internal-only, or excluded for OAuth connectors
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/pymaia/apis/pymaia-api.md) · [All operations](https://skmtc.dev/pymaia/apis/pymaia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pymaia/apis/pymaia-api/revisions/705a6973177b?raw)