For the complete documentation index, see llms.txt. This page is also available as Markdown.

Run a Schedule Now

Start one run of a saved schedule straight away.

POST /jobs_schedule_run

Starts one run of a saved schedule now, in the background, and answers as soon as it has started. next_run then moves on as if the schedule had run on its date. Works on a paused schedule too; it stays paused.

Billed like a job search: 0.1 credit per new job saved, plus the people and emails found at their normal rates when the schedule has find_contact on. credits_estimated is the most the jobs part can cost. The balance is checked first; if it is too low the call returns 400 and nothing runs.

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

api_key

string

Required. Your API key.

schedule_id

integer

Required. From List Schedules.

Response

Field
Description

data.run_started

true when the run started.

data.next_run

The schedule's new next date.

credits_estimated

The most the jobs part can cost (0.1 x max_results).

credits_used

0: the run is billed as it happens.

Example

Check the result a few minutes later with Schedule Run History.