Skip to main content
PATCH
Update a Monitor
Send only the fields that change. Everything is checked as on create.
The response is the updated monitor, as in Get a Monitor. That change gave it "cron": "0 8 * * 1": Mondays at 8:00 in Lagos.
  • Changing sources starts the comparison over. The next check records a new starting point and doesn’t alert.
  • Sending notify with new email recipients sends them a confirmation email. recipients in the response lists their status.
  • Send "goal": null or "rule": null to remove them.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

monitorId
string
required

The monitor's ID.

Body

application/json
name
string

Defaults to the first source's label.

sources
object[]
Required array length: 1 - 10 elements
schedule
object

Your plan sets the shortest interval: daily on Free, hourly on Starter, every 15 minutes on Builder, every 5 minutes on Pro.

alertOn
enum<string>

What counts as a change. Default page when every source is a URL list, otherwise new.

Available options:
new,
changed,
removed,
page,
every
watchFields
string[]

alertOn changed: only these fields count. Empty means every field.

Maximum array length: 20
rule
object | null

Only alert about items where this is true, for example { "field": "price", "op": "drops_by_pct", "value": 10 }.

goal
string | null

Plain-language goal. When something changed, AI decides whether it matches before alerting, and says why.

Maximum string length: 1000
notify
object
checkNow
boolean
default:true

Create only: run the first check straight away. It records the starting point and doesn't alert.

Response

Updated.

status
enum<string>
Available options:
success
monitor
object
recipients
object[]