Enable/disable schedule

PATCH

/api/v1/schedules/{id}/toggle

Code sample: cURL

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

• Production

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.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

isEnabled

required

boolean

Example^generated

{
  "isEnabled": true
}

Responses

200

Schedule toggled. Body echoes { id, isEnabled }.

Media typeapplication/json

object

id

string

isEnabled

boolean

Example^generated

{
  "id": "example",
  "isEnabled": true
}

400

Validation failed — request body or query is missing/invalid

Media typeapplication/json

object

error

string

Example

{
  "error": "Missing or invalid \"url\" field"
}

401

Missing or invalid authentication token

Media typeapplication/json

object

error

string

Example

{
  "error": "Missing or invalid authentication token"
}

403

Insufficient permissions for this operation

Media typeapplication/json

object

error

string

Example

{
  "error": "No organization. Complete onboarding first."
}

404

Schedule not found.

500

Unexpected server error. Logs and PostHog $exception capture

Media typeapplication/json

object

error

string

Example

{
  "error": "Something went wrong"
}