Skip to main content
POST
Create calendar

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Create calendar request. cal_name is required.

cal_name
string
required

Calendar display name.

Required string length: 1 - 39
description
string

Calendar description.

Maximum string length: 499
timezone
string
default:Asia/Shanghai

IANA timezone. Defaults to Asia/Shanghai when empty.

team_id
integer<int64>

Owning team ID. 0 means no team.

workdays
integer[]

Workday numbers (0 = Sunday, 6 = Saturday).

Required range: 0 <= x <= 6
extra_cal_ids
string[]

Additional public-holiday calendar IDs to inherit events from (for example zh-cn.china.official).

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Create calendar response.