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.

POST /place_enrichment/batches/refresh

Mark batches for refresh

cURL

curl --request POST \
  --url https://api.repromptai.com/v1/{org}/place_enrichment/batches/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch_ids": [
    "batch_2024_03_15_123456",
    "batch_2024_03_16_123456"
  ],
  "refresh": true
}
'

import requests

url = "https://api.repromptai.com/v1/{org}/place_enrichment/batches/refresh"

payload = {
    "batch_ids": ["batch_2024_03_15_123456", "batch_2024_03_16_123456"],
    "refresh": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    batch_ids: ['batch_2024_03_15_123456', 'batch_2024_03_16_123456'],
    refresh: true
  })
};

fetch('https://api.repromptai.com/v1/{org}/place_enrichment/batches/refresh', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

The body is of type any.

Response

200

application/json

Batch refresh flags updated successfully