Sign in
Monitors

Update monitor

Update a monitor configuration, schedule, or status.

patch/api/v1/monitors/{id}

Path parameters

idstring required

Monitor ID.

Request body

namestring
configobject
cadence_minutesnumber
max_resultsnumber
force_freshboolean
cache_ttl_daysnumber
status'active' | 'paused'

Only active and paused are user-settable

Response

Monitor updated.

idstring required
namestring required
type'linkedin_keyword' | 'linkedin_profile' | 'linkedin_company' | 'linkedin_post' | 'instagram_profile' | 'instagram_post' | 'x_profile' | 'x_keyword' | 'reddit_keyword' | 'reddit_subreddit' | 'tiktok_keyword' | 'tiktok_hashtag' | 'web_search' | 'site_search' required
status'active' | 'paused' | 'disabled' required
configobject required
cadence_minutesnumber required
last_run_atstring nullable required
next_run_atstring nullable required
consecutive_failuresnumber required
created_atstring required
updated_atstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.