LinkedIn Extraction

Update a recurring export

Change the name, the cadence, or whether the schedule is paused. Omit a field to leave it. Sending the current value changes nothing, including an already-active schedule whose next run is overdue.

Renaming also renames the template extraction, which is the name the next run is created with. Changing the cadence recomputes the next run.

patch/v1/extractions/recurring/{schedule_id}/

Request

  • Base URL: https://api.evaboot.com
  • URL: https://api.evaboot.com/v1/extractions/recurring/{schedule_id}/
  • Auth: HTTP bearer

Path parameters

schedule_idstring uuid required

Request body

namestring nullable

Name of the schedule and of the template extraction. The next run is created with this name. Exports already produced keep theirs.

frequency'daily' | 'weekly' | 'monthly' nullable

New cadence. The next run is recomputed from the last one, so it can move sooner.

pausedboolean nullable

true stops future runs and keeps the schedule. false resumes it. Resuming an overdue schedule waits one full interval instead of firing immediately.

Example request

{
  "name": "Weekly CTOs",
  "frequency": "daily",
  "paused": true
}

Response

OK

idstring uuid required

Schedule id. Pass it to get, update, and delete.

namestring required

Name copied onto each future run.

frequencystring required

daily, weekly, or monthly.

pausedboolean required

When true, the scheduler skips this schedule.

search_urlstring required

The saved search on LinkedIn, without the new-since-last-run filter.

lead_searchboolean required

true for a people search, false for a company search.

template_extraction_idstring nullable

The extraction this schedule was started from, when it still exists. Same id GET /v1/extractions/{extraction_id}/ accepts.

last_execution_atstring date-time nullable

When the schedule last launched a run. Null before the first automatic run.

next_execution_atstring date-time nullable

When the next run is due. A paused schedule still reports the date it would have used.

runsinteger

Exports this schedule has already produced.

leadsinteger

Leads collected across those runs.

Example response

{
  "name": "Weekly CTOs",
  "frequency": "weekly",
  "lead_search": true,
  "runs": 3,
  "leads": 120,
  "destinations": [
    {
      "type": "hubspot",
      "label": "Sales CRM"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.