Skip to main content
POST
Start Bulk Enhance Job

Body

locations
object[]
required
callback_url
string<uri> | null

Optional webhook URL for posting results. If provided, results will be provided upon completion in the same format as the GET /bulk_enhance response.

check_cache
boolean

If false, bypass the cache and force a fresh fetch from all datasources.

delegate_to
string | null

If set, delegate this request to another user (requires delegation permissions).

include_raw_request
boolean
default:false

If true, include the raw request sent to the datasource for non cache hits. Does not support all datasources.

include_raw_response
boolean
default:false

If true, include the datasource's original response.

sources
enum<string>[]

Specify any desired third-party data sources to include for this location.

Available options:
PG,
PH,
LB
timeout
number<double>
default:300

Seconds before giving up. If timeout is reached, it will finalize the batch and provide any data that was aggregated in time.

Response

id
string<uuid>
required

Newly-created request ID. Use this as the id for future requests.