Skip to content

Update input config

PUT
/api/v1/integrations/inputs/{id}
Code sample: cURL
curl -X PUT 'https://dashboard.justcrawl.io/api/v1/integrations/inputs/iq_01ABC' \
-H 'Authorization: Bearer $JUSTCRAWL_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"maxUrlsPerDay":50000}'

Partial update — every body field is optional. Omitted fields preserve their existing value. Re-submitted credentials are re-encrypted before persistence (the encrypted blob is regenerated on every update, not diffed). The same bounded-range validation applies as on create (pollIntervalMs 1s..1h, maxUrlsPerDay 1..1M). Requires the org:manage permission.

id
required
string

Input queue config ID.

Media type application/json
object
name
string
credentials
object
queueUrl
string
workflowId
string
pollIntervalMs
integer
>= 1000 <= 3600000
maxUrlsPerDay
integer
>= 1 <= 1000000
Example generated
{
"name": "example",
"credentials": {},
"queueUrl": "example",
"workflowId": "example",
"pollIntervalMs": 1,
"maxUrlsPerDay": 1
}

Updated input queue configuration.

Media type application/json
object
id
string format: uuid
name
string
queueType
string
Allowed values: sqs webhook
queueUrl
string
nullable
workflowId
string format: uuid
nullable
isEnabled
boolean
pollIntervalMs
integer
maxUrlsPerDay
integer
webhookUrl
string
nullable
lastPolledAt
string format: date-time
nullable
lastError
string
nullable
createdAt
string format: date-time
Example
{
"queueType": "sqs"
}

Validation failed — request body or query is missing/invalid

Media type application/json
object
error
string
Example
{
"error": "Missing or invalid \"url\" field"
}

Missing or invalid authentication token

Media type application/json
object
error
string
Example
{
"error": "Missing or invalid authentication token"
}

Insufficient permissions for this operation

Media type application/json
object
error
string
Example
{
"error": "No organization. Complete onboarding first."
}

Input queue config not found.

Unexpected server error. Logs and PostHog $exception capture

Media type application/json
object
error
string
Example
{
"error": "Something went wrong"
}