Update alert rule

patch

https://core-api.ternary.app/api/alert-rules/{alertRuleID}

Update an existing alert rule. Only the fields included in the request body are modified; omitted fields remain unchanged.

Common updates include changing the condition parameters, adjusting filters or dimensions, updating subscriber lists, or toggling the status between active and inactive.

Path Params

alertRuleID

string

required

length ≥ 1

Unique alert rule ID

Body Params

condition

Alert triggered by increases and decreases, increases only or decreases only

dataSource

string

enum

Data source that triggers the alert

dimensions

array of strings

Dimension for the alert

dimensions

excludeTax

boolean

Alert threshold pre or post tax

filters

array of objects

Filter alters based on conditions

filters

measure

string

Alert measure e.g. cost

name

string

length ≥ 1

The name of the alert

subscribers

object

slackChannelIDs

array of strings

Slack channel IDs to send notifications to

slackChannelIDs

status

string

enum

Status of the alert, active or inactive

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden