跳转到主要内容
POST
创建或更新日历事件

限制说明

使用说明

  • 事件覆盖 [start_at, end_at) 这些日期,格式为 YYYY-MM-DD;end_at 必须晚于 start_at。
  • 不传 event_id 时创建新事件;传入的 event_id 必须是该日历已有的事件。
  • 写入时会把该日历自己的其他事件从这些日期上移除:完全落在范围内的事件被删除,部分重叠的被截短,跨越整个范围的被拆成两段,因此这些日期以最后一次写入为准。
  • 仅个人日历可修改,且仅限主体账户、管理员、日历创建者或日历所属团队成员操作,其他调用方返回 AccessDenied。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

日历事件创建/更新请求。传入 event_id 表示更新,留空表示创建。

cal_id
string
必填

日历 ID,可通过 POST /calendar/list 获取。

start_at
string
必填

事件开始日期,格式 YYYY-MM-DD。

end_at
string
必填

事件结束日期(不含),格式 YYYY-MM-DD。

is_off
boolean
必填

是否为非工作日。true = 休息日,false = 工作日覆盖。

event_id
string

事件 ID,创建时留空。

Maximum string length: 63
summary
string

事件摘要,选填。

Maximum string length: 39
description
string

事件描述。

Maximum string length: 499

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

/calendar/event/upsert 的响应。