Skip to main content
PATCH
/
api
/
alerts
/
{id}
Update Alert
curl --request PATCH \
  --url https://gdeltcloud.com/api/alerts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "check_frequency": "hourly"
}
'
{
  "success": true,
  "alert": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "sql_query": "<string>",
    "tables_used": [
      "<string>"
    ],
    "check_frequency": "hourly",
    "notification_email": "[email protected]",
    "enabled": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "description": "<string>",
    "natural_language_description": "<string>",
    "last_triggered_at": "<string>",
    "last_check_at": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Alert rule ID

Body

application/json
name
string | null

New alert name

description
string | null

New description

enabled
boolean | null

Enable or disable alert

check_frequency
enum<string>

New check frequency

Available options:
hourly,
12hourly,
daily,
weekly

Response

Successful response

success
boolean
required
alert
object
required