Updates the configuration of an existing Forward Schedule.
Request headers
|
Header |
Required |
Description |
|
|
Yes |
|
|
|
Yes |
|
|
|
No |
An optional idempotency key for requests with side effects. |
Path parameters
|
Parameter |
Type |
Required |
Description |
|
|
string |
Yes |
The ID of the Forward Schedule to update. |
Request body
|
Parameter |
Type |
Required |
Description |
|
|
string |
No |
The new name for the schedule. |
|
|
string |
No |
The new description for the schedule. |
|
|
string |
No |
The ID of the new Forward Template to associate. |
|
|
array |
No |
Replaces the initial event list. |
|
|
object |
No |
Updates the execution policy via merge. |
|
|
object|null |
No |
Updates the trigger policy. |
|
|
string |
No |
The ID of the new execution environment. |
|
|
object |
No |
Updates metadata via merge. |
Example request
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd' \
-H "Authorization: Bearer $QODER_PAT" \
-H "Content-Type: application/json" \
-d '{
"name": "Weekday tech brief",
"trigger_policy": {
"type": "cron",
"expression": "0 9 * * 1-5",
"timezone": "Asia/Shanghai"
}
}'
Example response
HTTP 200 OK
{
"id": "sched_019f00112233445566778899aabbccdd",
"identity_id": "idn_019eabc123",
"template_id": "tmpl_support",
"name": "Weekday tech brief",
"description": "Generate a daily technology news summary",
"status": "active",
"paused_reason": null,
"initial_events": [
{
"type": "user.message",
"content": "Summarize current technology news in five bullet points."
}
],
"execution": {
"session_mode": "new_session",
"max_concurrent_runs": 1,
"max_attempts": 1,
"timeout_ms": 300000
},
"trigger_policy": {
"type": "cron",
"expression": "0 9 * * 1-5",
"timezone": "Asia/Shanghai",
"upcoming_runs_at": ["2026-06-23T01:00:00Z"]
},
"environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
"sinks": [],
"metadata": {},
"archived_at": null,
"created_at": "2026-06-22T10:00:00Z",
"updated_at": "2026-06-22T10:30:00Z"
}
Response fields
Returns the updated Schedule object.
Errors
|
HTTP |
Type |
Code |
Trigger |
|
400 |
|
|
Trigger policy is invalid. |
|
400 |
|
|
Request body contains |
|
404 |
|
|
Schedule does not exist. |
|
409 |
|
|
Schedule is archived. |
Notes
-
HTTP update requests do not support updating
sinks. -
reuse_sessionmeans Forward manages a fixed execution Session for this Schedule; callers cannot provide an arbitrary existingsession_id.