Live Data
Preview a Live Data search
<small>Requires the contacts:write scope (or a broader one that includes it).</small>
Starts a Live Data preview for the given filters and returns a background job to poll. The job is tracked by GET /v3/background-jobs/{id}; on completion its jsonDataResult carries { contactsCount, companiesCount, sampleContacts }, where sampleContacts is a capped sample of matching contacts. A preview adds no prospects and consumes no credits.
post/v3/live-data/searches/preview
Request
- Base URLhttps://api.reply.io
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Preview accepted; poll the returned job for progress and results
Changes
No recorded changes to this operation across all 1 revision of this API.