Skip to main content
PATCH
Update alert API

Frequently asked questions

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.
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.
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

Authorization
string
header
required

API key in format tapi_live_[32-char] (live) or tapi_test_[32-char] (test)

Path Parameters

id
string
required

The alert id.

Example:

"alrt_9f2c4a1e"

Body

application/json
name
string
status
enum<string>
Available options:
active,
paused
webhook_url
string<uri>
filters
object

Row-level filters applied to every sweep. Firmographic keys use the same vocabulary as the Signals API.

crawl_cadence
enum<string>
Available options:
daily,
weekly,
monthly
delivery_frequency
enum<string>
Available options:
hourly,
daily

Response

The updated alert

success
boolean
Example:

true

data
object