Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Body
The name of the batch. Only for display purposes. Recommended to use a descriptive human readable name.
List of jobs to process. Maximum of 50,000 jobs per batch.
Optional unique identifier for the batch. If not provided, a new UUID will be generated. If an existing batch ID is provided, new jobs will be added to that batch.
Specifies the set of attributes to enrich. Defines the set of attributes to enrich for a place.
open_closed
, core
, all
Specifies the list of attributes to enrich. If this is specified it will override the attribute_set. You cannot specify both.
Flag to determine if jobs should be kicked off immediately. Only for internal use.
Response
Successfully submitted batch for processing
Represents the response when submitting a new batch of places for enrichment
Unique identifier for tracking the batch
"batch_2024_03_15_123456"
User-provided name to identify the batch
"NYC Restaurants March 2024"
Current processing status of the batch. Initially PENDING, changes to IN_PROGRESS when processing starts
pending
, queued
, in_progress
, completed
, failed
Batch statistics and metadata. Basic stats available to all organizations, detailed stats only for Reprompt.