Skip to main content
PATCH
Update monitor

PATCH /api/v1/monitors/:id

Update a monitor’s configuration or cadence.
Update any mutable field on an existing monitor.

Example

Authorizations

X-Access-Key
string
header
required

The public API key from the Credentials page.

X-Secret-Key
string
header
required

The API secret shown when the credential is created.

Path Parameters

id
string
required

Monitor ID.

Body

application/json
name
string
config
object
cadence_minutes
number
max_results
number
force_fresh
boolean
cache_ttl_days
number
status
enum<string>

Only active and paused are user-settable

Available options:
active,
paused

Response

Monitor updated.

id
string
required
name
string
required
type
enum<string>
required
Available options:
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
status
enum<string>
required
Available options:
active,
paused,
disabled
config
object
required
cadence_minutes
number
required
last_run_at
string | null
required
next_run_at
string | null
required
consecutive_failures
number
required
created_at
string
required
updated_at
string
required