Skip to main content
POST
Update Squid
This endpoint updates an existing squid’s settings using its hash ID. You can configure crawler parameters, execution settings, scheduling, notifications, and data delivery integrations.

Squid Settings

string
Display name for the squid. Example: "My Custom Squid"
boolean
Enable (true) or disable (false) the squid. Example: true
integer
Number of concurrent tasks to run simultaneously (1-20). Example: 2
boolean
Stop after all tasks complete (true) or run until credits exhausted (false). Example: false
boolean
Export only unique results, removing duplicates. Example: true
boolean
Remove newlines from exported data. Example: true
string
Notification preference: null (no notifications), “on_success”, or “on_error”. Example: "on_success"
string
Cron expression for scheduling automated runs. Example: "0 10 * * *"
string
Timezone identifier for schedule execution. Example: "Europe/Paris"

Headers

string
required
Your API authentication token. Value: Token YOUR_API_KEY
string
required
Must be application/json. Value: application/json

Query Parameters

string
required
The unique identifier (hash) of the squid to update. Example: e86b29c032024b66aff529e1d43c2bd7
The params object structure depends on the crawler. Use Get Crawler Parameters endpoint to see available options before updating.
Optional function parameters (in params.functions) cost extra credits per row. Check the crawler details for pricing.
Setting is_active to false will prevent the squid from running. Use this to temporarily pause a squid without deleting it.
You can update just one field at a time - send only the fields you want to change. Other settings remain unchanged.
Use cron_expression and timezone to schedule recurring runs. Common patterns: ‘0 9 * * *’ (daily at 9am), ‘0 0 * * 0’ (weekly on Sunday).

Code Examples

Response

200