Update alert API
Alerts
Update alert API
Edit an alert’s name, status, webhook URL, filters, crawl cadence or delivery frequency. Scope is immutable. Free.
PATCH
Update alert API
Frequently asked questions
How do I pause and resume an alert?
How do I pause and resume an alert?
Patch
status to paused to stop deliveries, and back to active to resume. While paused the watermark stays where it is, so resuming picks up from where you left off rather than replaying everything.What happens when I re-enable a disabled alert?
What happens when I re-enable a disabled alert?
It resumes with a clean failure count. A backlog guard caps how far back the resumed sweep reaches at 7 days, and the next payload carries a
gap note telling you that older events were skipped. An alert that has never swept is exempt, since its watermark is the backfill_days value you deliberately chose.Which fields cannot be changed?
Which fields cannot be changed?
The scope —
technology_id, category_id, domains and segment_id. The watermark’s meaning is bound to the scope, so changing it would corrupt delivery tracking. Delete and recreate instead.Authorizations
API key in format tapi_live_[32-char] (live) or tapi_test_[32-char] (test)
Path Parameters
The alert id.
Example:
"alrt_9f2c4a1e"
Body
application/json
Available options:
active, paused Row-level filters applied to every sweep. Firmographic keys use the same vocabulary as the Signals API.
Available options:
daily, weekly, monthly Available options:
hourly, daily