Update a schedule

PATCH

/api/v1/schedules/{schedule_id}

Change only the fields you send: {"enabled": false} pauses a schedule, {"enabled": true} resumes it. The change is merged onto the stored schedule and checked whole, so it obeys every rule a full save does — the target exists, the timing is valid.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

schedule_id*string

The schedule's id.

Request Body

application/json

body

[key: string]?any

Response Body

The schedule as it is now.

application/json

response

id?string

name?string

schedule_type?string

cron_expression?string

enabled?boolean

next_run_at?string

curl -X PATCH "https://api.synapseorch.com/api/v1/schedules/sched_01a10c2e4f6a8b0c1d3e5f7a9b1c3d5e" \  -H "Authorization: Bearer sk-syn-..." \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'

{  "id": "sched_01a10c2e4f6a8b0c1d3e5f7a9b1c3d5e",  "name": "Daily Sales Report",  "schedule_type": "cron",  "cron_expression": "0 8 * * 1-5",  "enabled": false,  "next_run_at": "2026-10-08T08:00:00+00:00"}