---
title: "Pause, resume or change an alert"
method: PATCH
path: "/api/v1/alerts/{id}"
---

# Pause, resume or change an alert

`PATCH /api/v1/alerts/{id}`

## Request

- Base URL: `https://invokely.ai`
- URL: `https://invokely.ai/api/v1/alerts/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`
  - none

Pause or resume an alert, change its events, email_mode or label, or rotate a webhook signing secret. Pass the id and only the fields to change.
Examples: {"id": "alr_3f9a...", "status": "paused"}. {"id": "alr_3f9a...", "status": "active"} resumes an alert paused after webhook failures. {"id": "alr_3f9a...", "rotate_secret": true} returns a new secret once; the old one stops working at once.
Returns {alert, secret?}.

## Path parameters

- `id` string, required

## Request body

- object
  - `status` 'active' | 'paused'
  - `events` string[]: What to be told about: "new_period" (a period not published before) and "revision" (a published value or its status changed). Default both.
  - `email_mode` 'instant' | 'daily'
  - `label` string
  - `rotate_secret` true: Webhook alerts only: issue a new signing secret.

## Response `200`

{"data": {"alert", "secret"?}}

- Data
  - `data` unknown, required

## Other responses

- `400`: Invalid argument (INVALID_ARGUMENT).
- `401`: API key required (UNAUTHORIZED).
- `404`: No such alert (ITEM_NOT_FOUND).
- `429`: More than 60 alert calls a minute (RATE_LIMITED).

---

[API](https://skmtc.dev/invokely/apis/invokely-statistics-api.md) · [All operations](https://skmtc.dev/invokely/apis/invokely-statistics-api/llms.txt) · [OpenAPI document](https://skmtc.dev/invokely/apis/invokely-statistics-api/revisions/3b0f775bccb6?raw)