Skip to main content
PATCH
Update a schedule
Send only what you want to change: cron or every, timezone, inputs, enabled, and, for a skill schedule only, max_results. enabled: false pauses it; runs missed while paused are not made up later. Needs skills:write (skill schedule) or workflows:write (workflow schedule). Switching a workflow schedule on also needs workflows:invoke. MCP tool: update_schedule.

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix, as Authorization: Bearer vd_sk_.... Create keys in Settings → API Keys.

Headers

Idempotency-Key
string

Any unique string (such as your order id). Resending the same request with the same key within 24 hours returns the first answer (with Idempotent-Replayed: true) and does nothing twice; the same key with a different request is a 422 idempotency_key_reused.

Required string length: 1 - 255

Path Parameters

schedule_id
string
required

Body

application/json

PATCH /v1/schedules/{id}: only what is sent changes. max_results is for a skill's schedule (rows per run); a workflow schedule refuses it.

cron
string | null
every
string | null
timezone
string | null
inputs
Inputs · object | null
enabled
boolean | null
max_results
integer | null
Required range: 0 <= x <= 500

Response

The schedule after the change.

id
string
required
workflow_id
string
required
workflow_slug
string
required
enabled
boolean
required
frequency
string | null
required

The canonical frequency, e.g. cron:0 9 * * 1 or daily:02:00.

kind
string
default:workflow
cron
string | null
every
string | null
timezone
string
default:UTC
inputs
Inputs · object
next_run_at
string | null
last_run_at
string | null
created_at
string | null