Skip to main content
PUT
Replace the search behind a table

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id
string<uuid>
required

Body

application/json

The body for appending to an existing table, or editing its saved search.

Enrichments are optional here: the destination table is the user's own and may already carry the columns they want.

record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
table_name
string
required
Required string length: 1 - 255
companies
CompanyQuerySchema · object | null

Filters for a company search.

enrichments
enum<string>[]

What to find out about the rows this lands. Each becomes its own column, and each is billed per row that comes back with an answer.

Maximum array length: 4

An enrichment offered at import, in the user's vocabulary not the catalog's.

Each option names an outcome and resolves to the curated enrichment that delivers it, so importing leads stays a question about what you want rather than about who supplies it.

Kept as its own enum rather than reusing the capability keys directly: the import page offers a deliberately short list, and which enrichments belong on it is a product decision that should not change every time the catalog gains a capability.

Available options:
find_email,
find_phone,
enrich_contact,
enrich_company
people
PeopleQuerySchema · object | null

Filters for a people search.

row_limit
integer | null

Rows to land. Clamped further by the organisation's plan cap; omit for the maximum.

Required range: 1 <= x <= 250000

Response

Successful Response

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

next_run_at
string<date-time> | null
required
query
Query · object
required
record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
row_limit
integer | null
required
schedule_at_minutes
integer | null
required
schedule_cadence
string | null
required
schedule_every_days
integer | null
required
schedule_timezone
string | null
required
table_id
string<uuid>
required
updated_at
string<date-time>
required