Update a discovery watch - Crustdata Docs

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version

enum<string>

default:2025-11-01

required

API version to use. 2025-11-01 is the only accepted value. Send it on every call: it is enforced today on POST /watch/{dataset}/search, where a missing or unrecognized value returns 400, and the other watch routes accept a request without it rather than relying on that.

Available options:

2025-11-01

Example:

"2025-11-01"

Path Parameters

dataset

enum<string>

required

The dataset the watch is built on.

Available options:

person,

company,

job

Example:

"person"

watch_id

integer

required

The watch's id, returned when it was created.

Example:

46936

Body

application/json

Body for updating a discovery watch. Only these three keys are accepted. Sending filters, sorts, on, fields, dataset, kind, or api_version returns 400.

status

enum<string>

New lifecycle state. cancelled is terminal.

Available options:

active,

paused,

cancelled

Example:

"paused"

config

object

Schedule and per-run caps for a discovery watch.

Show child attributes

notifications

object[]

Replaces the watch's channels wholesale.

One delivery channel. Every channel on a watch receives every notification.

Option 1
Option 2
Option 3
Option 4

Show child attributes

Response

The updated watch.

A discovery watch, as returned by create, get, list, and update.

integer

The watch's id. Use it on every management and run-history path.

Example:

47609

kind

enum<string>

Available options:

discovery

Example:

"discovery"

dataset

enum<string>

Available options:

person,

company,

job

Example:

"job"

api_version

string

Example:

"2025-11-01"

config_version

string

Version of the stored config shape.

Example:

"2025-11-01"

status

enum<string>

Lifecycle state. suspended is set by the system, most often for an insufficient balance, and blocks status changes until it is resolved.

Available options:

active,

paused,

suspended,

expired,

cancelled

Example:

"active"

filters

object

The saved filter, as sent at creation.

Option 1
Option 2

Show child attributes

string[]

Example:

["added"]

sorts

object[] | null

Show child attributes

fields

string[] | null

config

object

Schedule and per-run caps for a discovery watch.

Show child attributes

notifications

object[]

The configured channels. A stored channel secret is never returned.

One delivery channel. Every channel on a watch receives every notification.

Option 1
Option 2
Option 3
Option 4

Show child attributes

created_at

string<date-time>

Example:

"2026-07-16T03:16:38.351849Z"

last_run_at

string<date-time> | null

When the watch last ran. null until the baseline run completes.

Example:

"2026-08-04T05:32:47.000000Z"

notifications_count

integer

All-time count of records this watch has delivered.

Example:

128

credits_consumed

number

All-time credits this watch has spent.

Example:

64

last_notified_at

string<date-time> | null

When this watch last delivered anything.

Example:

"2026-08-04T05:32:47.000000Z"