Skip to main content
PUT
Set a search's run cadence

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Query Parameters

dry_run
boolean
default:false

Check the cadence and answer its next firings, and schedule nothing.

Body

application/json

A search's run cadence. Returning it to manual runs is deleting the schedule.

cadence
enum<string>
required

How often a table's search runs on its own: on a calendar step, or every few days.

Available options:
daily,
weekly,
monthly,
quarterly,
custom
at_minutes
integer | null
Required range: 0 <= x <= 1439
every_days
integer | null
Required range: 1 <= x <= 365
starts_on
string<date> | null

The first day the schedule may run, as YYYY-MM-DD in timezone. Nothing runs before it, and next_runs count from it. Null, or a day already past, starts at once.

timezone
string | null
Maximum string length: 64

Response

Successful Response

The scheduled search, plus its next few firings for preview.

next_runs
string<date-time>[]
required
source
LeadSearchSourceResponseSchema · object
required

The persisted search behind a table, in the request's own shape.