创建或更新日历事件

创建或更新日历事件（节假日或工作日覆盖）。不传 event_id 时会创建新事件。

POST /calendar/event/upsert

创建或更新日历事件

cURL

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"
}
'

import requests

url = "https://api.flashcat.cloud/calendar/event/upsert?app_key="

payload = {
    "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"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.flashcat.cloud/calendar/event/upsert?app_key=', 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.flashcat.cloud/calendar/event/upsert?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.flashcat.cloud/calendar/event/upsert?app_key="

	payload := strings.NewReader("{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"summary\": \"Labour Day\",\n  \"start_at\": \"2024-05-01\",\n  \"end_at\": \"2024-05-06\",\n  \"is_off\": true,\n  \"description\": \"International Workers Day holiday\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.post("https://api.flashcat.cloud/calendar/event/upsert?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"summary\": \"Labour Day\",\n  \"start_at\": \"2024-05-01\",\n  \"end_at\": \"2024-05-06\",\n  \"is_off\": true,\n  \"description\": \"International Workers Day holiday\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/calendar/event/upsert?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cal_id\": \"cal.QiNvtdKs4Wj52kZhT3LafM\",\n  \"summary\": \"Labour Day\",\n  \"start_at\": \"2024-05-01\",\n  \"end_at\": \"2024-05-06\",\n  \"is_off\": true,\n  \"description\": \"International Workers Day holiday\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "cal_id": "cal.QiNvtdKs4Wj52kZhT3LafM",
    "event_id": "cale.KyG9XWTCU5CucbwukEVBQ4",
    "summary": "Test Holiday"
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	服务日历管理（on-call）

授权

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 | null · 必填

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

event_id · string

事件 ID，创建时留空。

Maximum string length: 63

description · string

事件描述。

Maximum string length: 499

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

/calendar/event/upsert 的响应。

Show child attributes