跳转到主要内容
POST
/
calendar
/
event
/
upsert
创建或更新日历事件
curl --request POST \
  --url 'https://api.flashcat.cloud/calendar/event/upsert?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
  "summary": "Labour Day",
  "start_at": "2024-05-01",
  "end_at": "2024-05-06",
  "is_off": true,
  "description": "International Workers Day holiday"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
    "event_id": "cale.KyG9XWTCU5CucbwukEVBQ4",
    "summary": "Test Holiday"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

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

cal_id
string
必填

日历 ID。

summary
string
必填

事件摘要。

Required string length: 1 - 39
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
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 的响应。