---
title: "Change an alert rule's name, trigger, brands, cadence, channels or whether it is enabled; webhook_url null removes the webhook."
method: PATCH
path: "/v1/workspaces/{ws}/alerts/{alertId}"
tags: ["alerts"]
---

# Change an alert rule's name, trigger, brands, cadence, channels or whether it is enabled; webhook_url null removes the webhook.

`PATCH /v1/workspaces/{ws}/alerts/{alertId}`

## Request

- Base URL: `https://api.storequant.com`
- URL: `https://api.storequant.com/v1/workspaces/{ws}/alerts/{alertId}`
- Auth: HTTP bearer

Change an alert rule's name, trigger, brands, cadence, channels or whether it is enabled; webhook_url null removes the webhook. Scope `alerts:write`; cache `none`.

## Path parameters

- `ws` string, required
- `alertId` string, uuid, required

## Request body

- object
  - `name` string
  - `event_type` 'new_ads' | 'paused_ads' | 'page_change' | 'new_partner' | 'coverage'
  - `brand_ids` string[]
  - `cadence` 'daily' | 'weekly'
  - `enabled` boolean
  - `email` boolean
  - `webhook_url` string, uri, nullable
  - `webhook_kind` 'generic' | 'slack'

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `event_type` 'new_ads' | 'paused_ads' | 'page_change' | 'new_partner' | 'coverage', required
    - `brand_ids` string[], required
    - `cadence` 'daily' | 'weekly', required
    - `enabled` boolean, required
    - `email` boolean, required
    - `webhook` object, nullable, required
      - `kind` 'generic' | 'slack', required
      - `host` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `meta` object, required
    - `request_id` string, required
    - `as_of` string, date-time, required
    - `lag_hours` number
    - `cursor` string
    - `count` integer

## Other responses

- `4XX`: The one error shape.
- `5XX`: The one error shape.

---

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