Toggle alert status

PATCH /v0/alerts/{alertId}

cURL

activate

curl --request PATCH \ --url https://api.formo.so/v0/alerts/{alertId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "status": "active" } '

200

{
  "id": "<string>",
  "name": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "trigger_filters": [
    {
      "name": "<string>",
      "value": "<string>",
      "operator": "<string>",
      "numericThreshold": "<string>"
    }
  ],
  "recipient": [
    {
      "value": [
        "<string>"
      ]
    }
  ],
  "has_secret": true
}

Authorizations

Authorization · string · header · required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API Keys.

Path Parameters

alertId · string · required

Body

application/json

status · enum<string> · required

Available options: active, inactive

Response

200 - application/json

Alert status updated

id · string · required

name · string · required

trigger_type · enum<string> · required

Available options: event, user

status · enum<string> · required

Available options: active, inactive

project_id · string · required

created_at · string<date-time>

updated_at · string<date-time> | null

trigger_filters · object[]

Show child attributes

recipient · object[]

Show child attributes

has_secret · boolean