v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Live Data

Start a Live Data search

<Warning> **Coming soon.** This endpoint will be available by early July 2026. </Warning>

<small>Requires the contacts:write scope (or a broader one that includes it).</small>

Starts a Live Data search that finds contacts matching the filters and adds them as prospects (optionally moving them into a sequence and/or lists). Consumes credits from the Reply credit pool per resulting contact. Returns the created search's id; track its progress via GET /v3/live-data/searches/{id}.

post/v3/live-data/searches

Request body

contactsCountToAddinteger required

Number of contacts to find and add

addContactsWithoutEmailsboolean

When true, contacts without an email address are still added

maxPeoplePerCompanyinteger

Maximum contacts to add per company. Optional; defaults to 1 when omitted.

sequenceIdinteger nullable

Sequence to move the found contacts into

listIdsinteger[]

Prospect lists to add the found contacts to

referenceUrlstring nullable

Optional reference URL used to seed the search

searchContactPhonesboolean

When true, enrich phone numbers during the search

Response

Search started

searchIdinteger required

Id of the created search; poll GET /v3/live-data/searches/{id}.