Skip to main content
POST
/
v1
/
monitors
/
{monitor_id}
Update Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "frequency": "<string>"
}
'
{
  "id": "<string>",
  "object": "monitor",
  "team_id": "<string>",
  "fda_id": "<string>",
  "query": "<string>",
  "frequency": "<string>",
  "cron_expression": "<string>",
  "notification_target": "<string>",
  "metadata": {},
  "output_schema": {},
  "error_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Merge semantics: Metadata updates follow Stripe’s approach — new keys are added, existing keys are updated, and keys set to empty string "" are deleted.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
monitor_id
string
required

Unique monitor identifier. Must start with monitor_.

Pattern: ^monitor_

Body

application/json
​
metadata
object

Metadata patch. Empty string values delete keys.

​
frequency
string

Natural-language schedule instruction (for example: 'every day at 9am America/Los_Angeles'). If no timezone is specified, UTC is used.

Response

Monitor updated successfully.

​
id
string

Unique monitor identifier.

​
object
string
Example:

"monitor"

​
team_id
string
​
status
enum<string>

Monitor lifecycle status. Common values: active (running on schedule), paused (schedule disabled via /pause, can be resumed via /resume), deleted (soft-deleted).

Available options:
active,
paused,
deleted
​
fda_id
string
​
query
string

Monitoring intent in natural language. If the query includes a URL, the monitor will focus on that URL.

​
frequency
string

Natural-language schedule instruction (for example: 'every day at 9am America/Los_Angeles' or 'every weekday at 14:30'). If no timezone is specified, UTC is used.

​
cron_expression
string | null
​
notification_channel
enum<string>
Available options:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object

Optional JSON schema used to enforce structured monitor extraction output.

​
error_message
string | null
​
created_at
integer

Unix timestamp.

​
updated_at
integer

Unix timestamp.