Update Alert Config

PATCH https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId

Update an existing alert configuration (name, settings, email frequency, or enabled state).

Example request

curl -X PATCH "https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN"

const options = {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  }
};

fetch("https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.patch("https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId", headers=headers)
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.SendAsync("https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.podengine.ai/api/v1/alerts/alert-config/:alertConfigId", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.alerts.updateAlertConfig({
  alertConfigId: '<alertConfigId>',
  updates: {
    alertName: 'string',
    emailSettings: {
      frequency: 'hourly',
    },
    alertSettings: {
      type: 'person',
      value: 'string',
      trackGuestAppearances: true,
      trackHostAppearances: true,
      trackMentions: true,
      genresToSkip: ['string'],
      genresToInclude: ['string'],
      otherSpellings: ['string'],
      otherEmails: ['name@example.com'],
      contextAwareQuestion: 'string',
      contextAwareDetails: {
        what: 'string',
        relevantClues: 'string',
        commonFalsePositives: 'string',
      },
      filterAdvertisements: true,
      filters: {
        excludeAds: true,
        requireSubject: true,
      },
      subjectNote: 'string',
    },
    enabled: true,
  },
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.alerts.update_alert_config(
    alert_config_id="<alertConfigId>",
    updates={
        "alertName": "string",
        "emailSettings": {
            "frequency": "hourly",
        },
        "alertSettings": {
            "type": "person",
            "value": "string",
            "trackGuestAppearances": True,
            "trackHostAppearances": True,
            "trackMentions": True,
            "genresToSkip": ["string"],
            "genresToInclude": ["string"],
            "otherSpellings": ["string"],
            "otherEmails": ["name@example.com"],
            "contextAwareQuestion": "string",
            "contextAwareDetails": {
                "what": "string",
                "relevantClues": "string",
                "commonFalsePositives": "string",
            },
            "filterAdvertisements": True,
            "filters": {
                "excludeAds": True,
                "requireSubject": True,
            },
            "subjectNote": "string",
        },
        "enabled": True,
    },
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "updatedAlertConfig": {
      "id": "string",
      "createdByUserId": "string",
      "teamId": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z",
      "alertName": "string",
      "alertType": "person",
      "enabled": true,
      "alertSettings": {
        "type": "person",
        "value": "string",
        "trackGuestAppearances": true,
        "trackHostAppearances": true,
        "trackMentions": true,
        "genresToSkip": [
          "string"
        ],
        "genresToInclude": [
          "string"
        ],
        "otherSpellings": [
          "string"
        ],
        "otherEmails": [
          "name@example.com"
        ],
        "contextAwareQuestion": "string",
        "contextAwareDetails": {
          "what": "string",
          "relevantClues": "string",
          "commonFalsePositives": "string"
        },
        "filterAdvertisements": true,
        "filters": {
          "excludeAds": true,
          "requireSubject": true
        },
        "subjectNote": "string"
      },
      "emailSettings": {
        "frequency": "hourly"
      },
      "lastRunDate": "2026-01-15T09:30:00.000Z",
      "subjectNoteCheck": {
        "status": "passed",
        "missing": "string"
      }
    }
  }
}

Request

Path parameters

alertConfigIdstringrequired

ID of the alert configuration.

Request body

updatesobjectrequired4 fields

Fields to update; omitted fields retain their current values.

alertNamestring

New display name for the alert.

emailSettingsobject1 field

Replacement email notification schedule.

frequencyenumrequired

How often alert email notifications should be sent.

hourlydailyweekly

alertSettingsintersection

Replacement matching settings for this alert. If you leave out filters or subjectNote, the alert keeps the ones it has.

enabledboolean

Enable or disable this alert.

Response

200 application/json

statusliteral: OKrequired

dataobjectrequired1 field

updatedAlertConfigobjectrequired12 fields

idstringrequired

createdByUserIdstringrequired

teamIdstringrequired

createdAtdaterequired

updatedAtdaterequired

alertNamestringrequired

alertTypeenumrequired

personcompanycustom-keyword

enabledbooleanrequired

alertSettingsintersectionrequired

emailSettingsobjectrequired1 field

frequencyenumrequired

How often alert email notifications should be sent.

hourlydailyweekly

lastRunDatedaterequirednullable

subjectNoteCheckobjectnullable2 fields

Person and company alerts: the note check of the "Who is this?" note this alert uses. Null when there is no note.

statusenumrequired

passed: matches are checked for the right person or company. failed: see missing. pending: not checked yet.

passedfailedpending

missingstringrequirednullable

When the check failed, what the note needs to tell them apart, e.g. "Add their role or company."