curl --request PATCH \
--url https://api.example.com/schedule/{schedule_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"enabled": true,
"stateful": true
}
'import requests
url = "https://api.example.com/schedule/{schedule_id}"
payload = {
"name": "<string>",
"description": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"enabled": True,
"stateful": True
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
cron_expression: '<string>',
timezone: '<string>',
enabled: true,
stateful: true
})
};
fetch('https://api.example.com/schedule/{schedule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/schedule/{schedule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'cron_expression' => '<string>',
'timezone' => '<string>',
'enabled' => true,
'stateful' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/schedule/{schedule_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/schedule/{schedule_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedule/{schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"agent_id": "<string>",
"data": {
"name": "<string>",
"cron_expression": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"enabled": true,
"timezone": "Asia/Shanghai",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"stateful": false,
"permission_mode": "dont_ask",
"source": "USER",
"source_session_id": ""
},
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update a schedule
Partially update a schedule.
Fields omitted from the request body keep their current values.
Changing cron_expression or timezone immediately reschedules the
APScheduler job. Setting enable=False removes the job from the
scheduler without deleting the record.
Args:
schedule_id (str): ID of the schedule to update.
body (UpdateScheduleRequest): Fields to update.
user_id (str): Authenticated user ID.
storage (StorageBase): Storage instance.
scheduler (SchedulerManager): Scheduler manager.
Returns:
ScheduleRecord:
The updated schedule record.
Raises:
HTTPException: 404 if the schedule does not exist.
curl --request PATCH \
--url https://api.example.com/schedule/{schedule_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"enabled": true,
"stateful": true
}
'import requests
url = "https://api.example.com/schedule/{schedule_id}"
payload = {
"name": "<string>",
"description": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"enabled": True,
"stateful": True
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
cron_expression: '<string>',
timezone: '<string>',
enabled: true,
stateful: true
})
};
fetch('https://api.example.com/schedule/{schedule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/schedule/{schedule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'cron_expression' => '<string>',
'timezone' => '<string>',
'enabled' => true,
'stateful' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/schedule/{schedule_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/schedule/{schedule_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedule/{schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"timezone\": \"<string>\",\n \"enabled\": true,\n \"stateful\": true\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"agent_id": "<string>",
"data": {
"name": "<string>",
"cron_expression": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"enabled": true,
"timezone": "Asia/Shanghai",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"stateful": false,
"permission_mode": "dont_ask",
"source": "USER",
"source_session_id": ""
},
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
Request body for partially updating a schedule.
Omit any field to keep its current value. Changing cron_expression
or timezone will reschedule the APScheduler job immediately.
Changing enable to False removes the job from the scheduler
without deleting the record; setting it back to True re-registers it.
Response
Successful Response
Persisted schedule record.