Skip to main content
PATCH
Update a monitor
0 credits Requires monitors:write permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Path Parameters

monitor_id
string
required

ID of the monitor.

Example:

"mon_123"

Body

application/json

Send only the fields to change. target replaces the whole target.

name
string

Display name for the monitor.

Required string length: 1 - 200
Example:

"Acme pricing monitor"

tags
string[]

Labels for filtering monitors, their changes, and their usage.

Maximum array length: 20
Required string length: 1 - 50
Example:
status
enum<string>

Set paused to stop scheduled runs or active to resume them.

Available options:
active,
paused
target
Page target · object

What to watch: a page, a sitemap, or data extracted from a site.

change_detection
Exact · object

How changes are judged. Defaults to semantic for extract targets and page targets with instructions, otherwise exact.

schedule
Interval · object

How often the monitor runs. Defaults to once a day.

webhook
object | null

Set to null to remove the webhook. Changing url issues a new secret.

Response

Updated monitor

mode
enum<string>
required

Always web. Optional.

Available options:
web
id
string
required
Example:

"mon_123"

name
string
required
Example:

"Acme pricing monitor"

target
Page target · object
required

What to watch: a page, a sitemap, or data extracted from a site.

change_detection
Exact · object
required

How changes are judged. Defaults to semantic for extract targets and page targets with instructions, otherwise exact.

status
enum<string>
required

Current state. Failed monitors keep running; paused monitors must be resumed with status: "active".

Available options:
active,
paused,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

schedule
Interval · object

How often the monitor runs. Defaults to once a day.

webhook
object | null

Webhook destination and delivery settings. Null means no webhook is configured.

last_run_at
string<date-time> | null
last_change_at
string<date-time> | null
next_run_at
string<date-time> | null

When the next scheduled run is due; null while paused.

last_error
object | null

Error from the most recent failed run; null when the last run succeeded.

webhook_failure
object | null

Present while webhook deliveries are failing consecutively; null when deliveries are healthy or no webhook is configured. Cleared on the next successful delivery and when the webhook URL changes.

tags
string[]

Labels for filtering monitors, their changes, and their usage.

Maximum array length: 20
Required string length: 1 - 50
Example:
baseline
Page baseline · object

Comparison baseline, included on Retrieve. Null until capture completes or after target changes.

key_metadata
object

Credits this request used and your remaining balance.