Skip to main content
POST
companies.signals.monitor.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The watch to change.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
schedule
string

A new five-field UTC cron for the checks. Only schedules the source serves exactly are accepted (daily, hourly intervals, every N days, weekly, monthly days 1-28). A schedule that would find more signals than the watch finds now still bills the same way: per signal, daily.

Maximum string length: 120
status
enum<string>

"paused" stops the checks and the billing; "active" resumes them.

Available options:
active,
paused
name
string

A new label for the watch.

Required string length: 1 - 100

Response

The result

domain
string
required

The watched company's website domain.

schedule
string
required

Five-field cron expression, UTC, the checks run on.

name
string

The watch's label.

status
enum<string>

Current state of the watch.

Available options:
active,
paused,
error
createdAt
string

When the watch was created, ISO 8601.

lastRunAt
string

When the watch last ran, ISO 8601.

nextRunAt
string

When the watch runs next, ISO 8601.