更新 Schedule

POST /api/v1/forward/schedules/{schedule_id} 使用 merge-patch 语义：请求体中出现的字段会被更新，未出现字段保持不变。

请求头

Header	是否必填	说明
Authorization	是	`Bearer <PAT 或 SAT>`
Content-Type	是	`application/json`
Idempotency-Key	否	有副作用请求可选的幂等键。

路径参数

参数	类型	是否必填	说明
schedule_id	string	是	Forward Schedule ID。

请求体参数

参数	类型	是否必填	说明
name	string	否	新的 Schedule 名称。
description	string	否	新的 Schedule 描述。
template_id	string	否	新的 Forward Template ID。
initial_events	array	否	替换初始事件列表。
execution	object	否	合并更新执行策略。
trigger_policy	object\|null	否	更新触发策略；`null` 表示改为 manual。
environment_id	string	否	新的执行环境。
sinks	array\|null	否	执行结果推送目标；为兼容性保留数组形式，当前最多允许一个元素。
metadata	object	否	合并更新 metadata；value 为 `null` 删除 key。

触发策略

trigger_policy 是按 type 分发的对象。创建和更新请求只接收配置字段：type、expression、timezone。更新时传 null 表示改为 {"type":"manual"}。upcoming_runs_at、last_run_at 是服务端计算出的响应字段。

字段	类型	是否必填	说明
type	string	是	`cron`、`once`、`interval` 或 `manual`。
expression	string	条件必填	触发表达式；`cron`、`once`、`interval` 必填，`manual` 不需要。
timezone	string	条件必填	IANA timezone，例如 `Asia/Shanghai`；`cron` 必填，`once` 在表达式不带时区时必填，`interval` 和 `manual` 可省略。
upcoming_runs_at	array	响应返回	后续触发时间，UTC ISO 8601。当前实现返回 `[]` 或最多一个下一次计划触发时间。
last_run_at	string\|null	响应返回	最近一次触发时间。

type	创建/更新入参	说明
`cron`	`type`、`expression`、`timezone`	使用 5 字段 cron 表达式按指定 IANA timezone 重复触发。
`once`	`type`、`expression`、可选 `timezone`	按 ISO 8601 时间触发一次；表达式不带 offset 时必须提供 `timezone`。
`interval`	`type`、`expression`	按 ISO 8601 duration 重复触发，例如 `PT15M`。
`manual`	`type`	不自动触发，只能通过 Run Schedule 接口手动执行。

type	expression 格式	示例	说明
`cron`	标准 5 字段 cron	`0 9 * * *`	分钟级日历规则；不支持秒字段和 6 字段 cron。
`once`	ISO 8601 绝对时间	`2026-06-23T09:00:00` 或 `2026-06-23T01:00:00Z`	目标时间必须至少晚于服务端当前时间 1 分钟。
`interval`	ISO 8601 duration	`PT15M`、`PT1H`、`P1D`	固定间隔触发，最小粒度 1 分钟。
`manual`	省略或空字符串	-	不产生计划触发时间。

执行策略

execution 使用合并更新语义，未出现的字段保持原值。

字段	类型	默认值	说明
session_mode	string	`new_session`	Session 使用方式，取值 `new_session` 或 `reuse_session`。
max_concurrent_runs	integer	1	同一个 Schedule 最大并发 Run 数。
max_attempts	integer	1	单个 Run 的实际尝试次数上限，允许值为 `1` 或 `2`；小于 `1` 或大于 `2` 会被拒绝。
timeout_ms	integer	300000	单次尝试超时时间。

session_mode	说明
`new_session`	每次触发都创建新的执行 Session，不延续历史上下文。
`reuse_session`	Forward 为该 Schedule 管理一个固定执行 Session，并在多次触发间持续使用；调用方不能指定任意已有 `session_id`。

max_attempts=2 表示同一个 Schedule Run 在首次执行失败后，最多由服务端自动再尝试一次。是否重试由服务端根据失败类型判断；参数错误、权限错误、并发限制、超时或连接中断等场景不会保证重试。客户端可通过 Schedule Run 的 attempt 字段查看实际执行到第几次。更新时省略 execution、传 execution=null、传空对象，或传入不含 max_attempts 的局部 execution，都保留当前 max_attempts。显式传 execution.max_attempts=null 会作为参数类型错误处理，不表示删除或恢复默认值。

推送目标

sinks 为兼容性保留数组形式，当前最多允许一个元素。每个元素只能是以下公开格式之一：

{
  "type": "im_channel",
  "channel_id": "channel_xxx",
  "target": {
    "type": "user",
    "external_id": "536769"
  }
}

{
  "type": "im_channel",
  "channel_id": "channel_xxx",
  "target": {
    "type": "group",
    "external_id": "cid_group_123"
  }
}

target 使用渠道原生的用户或群组 external_id，不支持 thread 或 topic。在渠道 IM 会话中发送 /target，可获取当前会话的 target 配置。省略 sinks 保持原值，传入 null 或 [] 清空，传入一个元素替换。投递失败记录在对应 Run 的 push_status 中。

示例请求

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Weekday tech brief",
  "trigger_policy": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "Asia/Shanghai"
  },
  "execution": {
    "max_attempts": 2
  },
  "sinks": [
    {
      "type": "im_channel",
      "channel_id": "channel_xxx",
      "target": {
        "type": "user",
        "external_id": "536769"
      }
    }
  ]
}'

示例响应

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",
  "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": 2,
    "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": [
    {
      "type": "im_channel",
      "channel_id": "channel_xxx",
      "target": {
        "type": "user",
        "external_id": "536769"
      }
    }
  ],
  "metadata": {},
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T10:30:00Z"
}

响应字段

字段	类型	说明
返回值	object	更新后的 Schedule 对象。

错误

HTTP	Type	Code	触发条件
400	`invalid_request_error`	`invalid_trigger_policy`	触发策略不合法。
400	`invalid_request_error`	`invalid_request`	`execution.max_attempts` 不在 `1..2` 范围内。
400	`invalid_request_error`	`unsupported_sinks_input`	`sinks` 数量、类型或字段非法，或固定 Channel 不可用、归属不符或与最终执行上下文不匹配。
404	`not_found_error`	`schedule_not_found`	Schedule 不存在。
409	`invalid_request_error`	`schedule_archived`	Schedule 已归档。
401	`authentication_error`	`authentication_required`	PAT 或 SAT 无效或已过期。

备注

更新未传 sinks 时保留现值；传 null 或 [] 时清空。
reuse_session 表示 Forward 为该 Schedule 管理固定执行 Session，调用方不能指定任意已有 Session。

请求头

路径参数

请求体参数

触发策略

执行策略

推送目标

示例请求

示例响应

响应字段

错误

备注

相关

获取 Schedule

暂停 Schedule

​请求头

​路径参数

​请求体参数

​触发策略

​执行策略

​推送目标

​示例请求

​示例响应

​响应字段

​错误

​备注

​相关

获取 Schedule

暂停 Schedule

请求头

路径参数

请求体参数

触发策略

执行策略

推送目标

示例请求

示例响应

响应字段

错误

备注

相关