Skip to main content
PATCH
/
v1
/
scrapers
/
{retailerCode}
/
config
Update scraper configuration
curl --request PATCH \
  --url http://localhost:3000/v1/scrapers/{retailerCode}/config \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_enabled": true,
  "schedule_cron": "<string>",
  "schedule_description": "<string>",
  "location_ids": [
    "<string>"
  ],
  "max_workers": 25,
  "batch_size": 255,
  "rate_limit_delay": 5.25,
  "alert_on_failure": true,
  "alert_on_error_rate": true,
  "error_rate_threshold": 50
}
'
{
  "success": true,
  "config": "<unknown>"
}

Path Parameters

retailerCode
string
required

Body

application/json
is_enabled
boolean
schedule_cron
string | null
Maximum string length: 100
schedule_description
string | null
Maximum string length: 100
location_ids
string[] | null
max_workers
integer
Required range: 1 <= x <= 50
batch_size
integer
Required range: 10 <= x <= 500
rate_limit_delay
number
Required range: 0.5 <= x <= 10
alert_on_failure
boolean
alert_on_error_rate
boolean
error_rate_threshold
integer
Required range: 1 <= x <= 100

Response

200 - application/json

Configuration updated

success
boolean
required
config
unknown