Sign in

v3

OpenAPI 3.1.02026-07-318648277.6 KB
Bulk Jobs

Submit a Local Leads Search

Submit long-running local-leads searches to the dedicated bulk queue.

post/bulk/local-leads

Request body

object required

Response

Local-leads job accepted.

jobIdstring uuid required

UUID identifier for the bulk job.

productstring required

The enrichment product this job is running.

endpointstring nullable
totalRowsinteger required

Total number of rows in the submission.

statusstring required

Always 'uploaded' for a freshly submitted job.

statusUrlstring uri
streamUrlstring uri
wsUrlstring
resultsUrlstring uri
rowsUrlstring uri
errorsUrlstring uri
eventsUrlstring uri
eventsExportUrlstring uri
logsUrlstring uri
downloadUrlstring uri
progressUrlstring uri
tokenstring

Progress token for follow-up reads without the API key.

expinteger

Unix timestamp when the progress token expires.

Example response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "uploaded"
}