POST/v1/squids/{squid_hash}

Update Squid

Update squid settings including parameters, concurrency, scheduling, and delivery integrations

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

namestring

Optional

Display name for the squid.

Example: My Custom Squid

is_activeboolean

Optional

Enable (true) or disable (false) the squid.

Example: true

concurrencyinteger

Optional

Number of concurrent tasks to run simultaneously (1-20).

Example: 2

to_completeboolean

Optional

Stop after all tasks complete (true) or run until credits exhausted (false).

Example: false

export_unique_resultsboolean

Optional

Export only unique results, removing duplicates.

Example: true

no_line_breaksboolean

Optional

Remove newlines from exported data.

Example: true

run_notifystring

Optional

Notification preference: null (no notifications), "on_success", or "on_error".

Example: on_success

cron_expressionstring

Optional

Cron expression for scheduling automated runs.

Example: 0 10 * * *

timezonestring

Optional

Timezone identifier for schedule execution.

Example: Europe/Paris

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

Parameters

squid_hashstring

Required

The unique identifier (hash) of the squid to update

Example: e86b29c032024b66aff529e1d43c2bd7

Pro Tip

The params object structure depends on the crawler. Use Get Crawler Parameters endpoint to see available options before updating.

Note

Optional function parameters (in params.functions) cost extra credits per row. Check the crawler details for pricing.

Warning

Setting is_active to false will prevent the squid from running. Use this to temporarily pause a squid without deleting it.

Pro Tip

You can update just one field at a time - send only the fields you want to change. Other settings remain unchanged.

Pro Tip

Use cron_expression and timezone to schedule recurring runs. Common patterns: '0 9 * * *' (daily at 9am), '0 0 * * 0' (weekly on Sunday).