Skip to main content
POST
/
schedules
/
{schedule_id}
Update Schedule
curl --request POST \
  --url https://api.example.com/schedules/{schedule_id} \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "inputs": {},
  "cron": "<string>",
  "every": "<string>",
  "offset": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "status": "online"
}
'
{
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "every": "<string>",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "online",
  "cron": "<string>",
  "inputs": {},
  "offset": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "timeout": 123
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
schedule_id
string
required
Pattern: sch-[0-9a-f]{32}

Query Parameters

​
workspace_id
string<uuid>
required

Body

application/json
​
inputs
Inputs · object
​
cron
string | null
​
every
string<duration> | null

ISO 8601 duration string

​
offset
string<duration> | null

ISO 8601 duration string

​
start_at
string<date-time> | null

ISO 8601 datetime string

​
end_at
string<date-time> | null

ISO 8601 datetime string

​
status
enum<string> | null
Available options:
online,
offline

Response

Successful Response

​
owner_id
string<uuid>
required
​
every
string<duration>
required

ISO 8601 duration string

​
workflow_id
string<uuid>
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string
​
status
string
default:online
​
cron
string | null
​
inputs
Inputs · object
​
offset
string<duration> | null

ISO 8601 duration string

​
start_at
string<date-time> | null

ISO 8601 datetime string

​
end_at
string<date-time> | null

ISO 8601 datetime string

​
timeout
number | null

The maximum number of seconds to wait for the workflow to complete