Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
apiKey
string | null

Body

application/json
​
batch_name
string
required

The name of the batch. Only for display purposes. Recommended to use a descriptive human readable name.

​
jobs
PlaceJob · object[]
required

List of jobs to process. Maximum of 50,000 jobs per batch.

​
batch_id
string | null

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.

​
attribute_set
enum<string> | null

Deprecated preset applied to every job. Prefer an explicit attributes list. open_closed checks whether a place is open or permanently closed, while core and all both request closed_permanently, websites, phoneNumbers, openingHours, names, address, and categories. Merged with any explicit attributes.

Available options:
open_closed,
core,
all
​
attributes
string[] | null

Batch-level attribute keys applied to every job (copied onto each PlaceJob; same merge rules as a single job: combined with attribute_set).

​
kick_off_jobs_now
boolean
default:true

When true, jobs are enqueued for immediate processing and either attributes or attribute_set must be provided. When false, the batch is created without starting processing (upload only); attributes and attribute_set are optional.

​
owner_id
string | null

Response

Successfully submitted batch for processing

Represents the response when submitting a new batch of places for enrichment

​
id
string
required

Unique identifier for tracking the batch

Example:

"batch_2024_03_15_123456"

​
batch_name
string
required

User-provided name to identify the batch

Example:

"NYC Restaurants March 2024"

​
jobs
object
required
​
status
enum<string>
default:pending

Current processing status of the batch. Initially PENDING, changes to IN_PROGRESS when processing starts

Available options:
pending,
queued,
in_progress,
completed,
failed
Example:

"pending"

​
metadata
null

Batch statistics and metadata. Basic stats available to all organizations, detailed stats only for Reprompt.

​
attribute_statuses
Attribute Statuses · object | null

Status distribution per attribute (only populated when enrichments query param is provided)