Skip to content

Enable/disable schedule

PATCH
/api/v1/schedules/{id}/toggle
Code sample: cURL
curl -X PATCH 'https://dashboard.justcrawl.io/api/v1/schedules/sch_01ABC/toggle' \
-H 'Authorization: Bearer $JUSTCRAWL_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"isEnabled":false}'

Flips the schedule’s isEnabled flag without otherwise mutating it. A disabled schedule stays in the dashboard, retains its cron / tags / workflow binding, and resumes from the same cadence when re-enabled — it just won’t fire while off. Use this for incident-mode pauses; use DELETE to remove permanently. Requires verified email.

id
required
string
Media type application/json
object
isEnabled
required
boolean
Example generated
{
"isEnabled": true
}

Schedule toggled. Body echoes { id, isEnabled }.

Media type application/json
object
id
string
isEnabled
boolean
Example generated
{
"id": "example",
"isEnabled": true
}

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."
}

Schedule not found.

Unexpected server error. Logs and PostHog $exception capture

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