> ## Documentation Index > Fetch the complete documentation index at: https://syncupai-robbalian-cleanup-deprecated-docs.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Mark batches for refresh > Mark a list of batch IDs for refresh. Sets the `refresh` flag on PlaceEnrichmentBatchJob for the provided batch IDs. Only batches belonging to the organization tied to the API key are updated. The response includes which batch IDs were updated and which were missing. What refresh does: https://docs.repromptai.com/guides/monthly-refresh Refreshes re-run enrichment for places you've marked to detect changes over time. Runs execute on the 9th of every month, and by default re-run only the attributes that were already enriched for that place. Pass refresh=true to turn refresh on, or refresh=false to turn it off. ## OpenAPI ````yaml /openapi-v1.json post /place_enrichment/batches/refresh openapi: 3.1.0 info: title: Reprompt Place Enrichment API description: > ## Batch Processing Guide The `/place_enrichment/batches` endpoint allows you to submit multiple places in a single batch for attribute enrichment. The batch will be processed asynchronously, and you can track its status using the returned batch ID. #### Typical workflow: 1. Prepare your batch payload with: - A unique batch name for identification - List of places with their IDs and input data - Optional attribute set specification 2. Submit the batch using the POST `/place_enrichment/batches` endpoint 3. Use the returned batch ID to: - Check batch status at GET `/place_enrichment/batches/{batch_id}` - Retrieve results at GET `/place_enrichment/jobs?batchId={batch_id}` #### Submitting a Batch: Use POST `/place_enrichment/batches` to submit a batch. **Example Batch Payload:** ```json { "batch_name": "NYC Restaurants March 2024", "attributes": ["websites", "phoneNumbers", "socialHandles", "openingHours", "categories", "closed_permanently"], "jobs": [ { "place_id": "place_nyc_123", "inputs": { "name": "Joe's Pizza", "latitude": 40.7359, "longitude": -73.9911, "full_address": "7 Carmine St, New York, NY 10014", "street": "Carmine St", "city": "New York", "state": "NY", "postalCode": "10014", "house": "7", "country": "United States", "country_code": "US", "type": "restaurant", "website": "http://www.joespizzanyc.com", "phone": "+12122555803" } } ] } ``` **Place Input Parameters:** For more details on the place input parameters, see the ```UniversalPlace``` schema in the schemas section below. **Attributes:** The `attributes` parameter in your request specifies which attributes will be enriched. You can specify individual attributes like: - `["websites", "phoneNumbers"]` - Only enrich website and phone information - `["closed_permanently"]` - Only check if the business is permanently closed - `["websites", "phoneNumbers", "socialHandles", "openingHours", "categories", "closed_permanently"]` - Core business attributes - `["websites", "phoneNumbers", "socialHandles", "openingHours", "categories", "closed_permanently", "cuisine", "price_tier", "user_reviews", "menu_url"]` - Comprehensive enrichment For a full list of available attributes, see the enrichment schema documentation below. #### Tracking Batch Status: Use GET `/place_enrichment/batches/{batch_id}` to monitor the progress of your batch. The response includes: ```json { "id": "batch_2024_03_15_123456", "batch_name": "NYC Restaurants March 2024", "status": "in_progress", "jobs": { "pending": ["place_id_2", "place_id_3"], "in_progress": ["place_id_1"], "completed": ["place_id_4", "place_id_5"], "failed": [] }, "created_at": "2024-03-15T10:30:00Z", "updated_at": "2024-03-15T10:35:00Z" } ``` The status field will be one of: - `pending`: Batch is queued but not yet started - `in_progress`: Batch is currently being processed - `completed`: All jobs in the batch are finished - `failed`: Batch encountered critical errors #### Retrieving Job Results: Once jobs are completed, use GET `/place_enrichment/jobs?batchId={batch_id}` to get the enrichment results. The response includes: ```json { "jobs": [ { "place_id": "place_nyc_123", "status": "completed", "outputs": { "website": "https://www.joespizzanyc.com", "phone": "+12122555803", "social_profiles": { "instagram": "joespizzanyc", "facebook": "joespizzanyc" }, "open_closed_status": "Open", "price_tier": "$$", "last_enriched": "2024-03-15T10:35:00Z" }, "job_metadata": { "created_at": "2024-03-15T10:30:00Z", "completed_at": "2024-03-15T10:35:00Z", "processing_time_seconds": 300 } } ], "total_count": 1, "completed_count": 1 } ``` Each job result includes: - Original place ID for tracking - Enrichment outputs based on the requested attribute set - Job metadata including timing information - Processing status and any error details if failed **Attribute Statuses:** Attributes like name, address, phone number, and website include an `attribute_status` field indicating the verification state: | Status | Description | |--------|-------------| | NOT_RUN | The attribute was not processed | | RUN_CONDITION_FAILED | The attribute was processed but failed the run condition | | RUN | The attribute was processed | | ERROR | The attribute processing failed | Example response with attribute statuses: ```json { "outputs": { "website": "https://www.joespizzanyc.com", "phone": "+12122555803" }, "job_metadata": { "attribute_status": { "website": "RUN", "phone": "RUN", "address": "RUN", "name": "RUN" } } } ``` version: '1.0' servers: - url: https://api.repromptai.com/v1/{org} variables: org: default: reprompt description: The organization slug to use for the API security: [] paths: /place_enrichment/batches/refresh: post: tags: - batches summary: Mark batches for refresh description: >- Mark a list of batch IDs for refresh. Sets the `refresh` flag on PlaceEnrichmentBatchJob for the provided batch IDs. Only batches belonging to the organization tied to the API key are updated. The response includes which batch IDs were updated and which were missing. What refresh does: https://docs.repromptai.com/guides/monthly-refresh Refreshes re-run enrichment for places you've marked to detect changes over time. Runs execute on the 9th of every month, and by default re-run only the attributes that were already enriched for that place. Pass refresh=true to turn refresh on, or refresh=false to turn it off. operationId: >- mark_batches_refresh_endpoint__org_slug__place_enrichment_batches_refresh_post parameters: - name: apiKey in: header required: false schema: anyOf: - type: string - type: 'null' title: Apikey requestBody: required: true content: application/json: schema: $ref: 66961095-dbd0-4b70-a88c-b351c2d3addd example: batch_ids: - batch_2024_03_15_123456 - batch_2024_03_16_123456 refresh: true responses: '200': description: Batch refresh flags updated successfully content: application/json: schema: $ref: 574a4b6c-b7e4-460d-85c8-ac6aaeacccd2 '400': description: Invalid input format '401': description: Invalid API credentials '403': description: API key does not match organization slug security: - HTTPBearer: [] components: securitySchemes: HTTPBearer: type: http scheme: bearer ````