Skip to main content
PATCH
Update a monitor

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 200
Example:

"Competitor pricing"

schedule
object
targets
object[]

What to watch, up to 10 targets: pages, a whole site, or a search.

webhook
object
retentionDays
number
default:30

How many days of check history to keep.

Required range: 1 <= x <= 365
email
enum<string>
default:off

Send the workspace owner a daily email listing what this monitor found. Nothing is sent on a day without changes.

Available options:
off,
daily
status
enum<string>

Pause a monitor or start it again.

Available options:
active,
paused

Response

data
object
required