Update schedule

PUT

/api/v1/schedules/{id}

Code sample: cURL

curl -X PUT 'https://dashboard.justcrawl.io/api/v1/schedules/sch_01ABC' \
  -H 'Authorization: Bearer $JUSTCRAWL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"frequency":"every_6_hours","isEnabled":true}'

• Production

Partial update — every field in the body is optional. Omitted fields inherit from the existing schedule, except cron-derived ones: any of frequency, timeOfDay, dayOfWeek, dayOfMonth, or cronExpr triggers a full cron recompute against the current values, and nextRunAt is rederived from the new cron + the (possibly changed) timezone. Switching workflowId to an unpublished workflow returns 400 — the schedule must always reference a runnable workflow. Requires verified email.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

name

string

workflowId

string

nullable

frequency

string

Allowed values: every_5_minutes every_10_minutes every_15_minutes every_30_minutes hourly every_2_hours every_3_hours every_4_hours every_6_hours every_8_hours every_12_hours daily weekly monthly custom

cronExpr

string

timezone

string

tagFilters

Array<string>

isEnabled

boolean

Responses

200

Updated schedule.

Media type application/json

object

id

string format: uuid

name

string

workflowId

string format: uuid

nullable

tagFilters

Array<string>

frequency

string

Allowed values: hourly daily weekly monthly custom

cronExpr

string

timezone

string

isEnabled

boolean

nextRunAt

string format: date-time

lastRunAt

string format: date-time

nullable

createdAt

string format: date-time

Example

{
  "frequency": "hourly"
}

400

Validation failed — request body or query is missing/invalid

Media type application/json

object

error

string

Example

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

401

Missing or invalid authentication token

Media type application/json

object

error

string

Example

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

403

Insufficient permissions for this operation

Media type application/json

object

error

string

Example

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

404

Schedule (or referenced workflowId) not found.

500

Unexpected server error. Logs and PostHog $exception capture

Media type application/json

object

error

string

Example

{
  "error": "Something went wrong"
}