---
title: "Set or clear a search's run cadence"
method: PUT
path: "/find-leads/tables/{table_id}/search/schedule/"
tags: ["find-leads"]
---

# Set or clear a search's run cadence

`PUT /find-leads/tables/{table_id}/search/schedule/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/find-leads/tables/{table_id}/search/schedule/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Schedule the table's search to run on a cadence, or return it to manual runs with a null cadence. The response previews the next three firings.

## Path parameters

- `table_id` string, uuid, required

## Request body

- LeadSearchScheduleRequestSchema: A search's run cadence; a null cadence returns it to manual runs.
  - `at_minutes` integer, nullable
  - `cadence` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'custom': How often a table's search runs on its own: on a calendar step, or every few days.
  - `every_days` integer, nullable
  - `starts_on` string, date, nullable: 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, nullable

## Response `200`

Successful Response

- LeadSearchScheduleResponseSchema: The scheduled search, plus its next few firings for preview.
  - `next_runs` string[], required
  - `source` LeadSearchSourceResponseSchema, required: The persisted search behind a table, in the request's own shape.
    - `next_run_at` string, date-time, nullable, required
    - `query` object, required
    - `record_type` 'people' | 'companies' | 'signal_companies' | 'signal_people' | 'lookalikes' | 'local_businesses' | 'hiring_companies' | 'backlinks' | 'search_results' | 'post_authors', required: Which dataset a search runs against, and so which provider serves it. Values are persisted in String(16) columns, so every member must stay within 16 characters.
    - `row_limit` integer, nullable, required
    - `schedule_at_minutes` integer, nullable, required
    - `schedule_cadence` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'custom', required: How often a table's search runs on its own: on a calendar step, or every few days.
    - `schedule_every_days` integer, nullable, required
    - `schedule_starts_on` string, date, nullable: The first day the schedule may run, in its own timezone; null when it started at once.
    - `schedule_timezone` string, nullable, required
    - `table_id` string, uuid, required
    - `updated_at` string, date-time, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: This table has no lead search.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)