Skip to main content
POST
Update calendar

Restrictions

Usage

  • Send at least one field besides cal_id; otherwise the call returns InvalidParameter.
  • workdays and extra_cal_ids replace the stored lists when sent (an empty array clears them); team_id: 0 removes the team.
  • cal_name must stay unique within the account.
  • Only personal calendars can be changed, and only by the account owner, an administrator, the calendar creator, or a member of the calendar’s team; other callers get AccessDenied.
  • On success the response carries only request_id; the data field is omitted.
  • Every call is recorded in the account audit log.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Update calendar request. cal_id is required; all other fields are optional and only applied when provided.

cal_id
string
required

Calendar ID; obtain it from POST /calendar/list.

cal_name
string | null

New calendar name; must be unique within the account.

Required string length: 1 - 39
description
string | null

New description.

Maximum string length: 499
timezone
string | null

New IANA timezone, e.g. Asia/Shanghai; an invalid name returns InvalidParameter.

team_id
integer<uint64> | null

New owning team ID; obtain it from POST /team/list. 0 removes the team; a nonzero ID must be a team of the account.

workdays
integer[]

Weekly working days, 0 = Sunday … 6 = Saturday. Days not listed are non-working days. When empty, no weekday is treated as non-working. When sent, replaces the stored list; omit to keep it.

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

Public calendar IDs to inherit events from (see POST /calendar/list with kind = region.official.holiday or exchange.holiday); at most one of them may be an exchange.holiday calendar, and linking one sets timezone to the exchange's. When sent, replaces the stored list; an empty array removes them all; omit to keep it.

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

Empty response body.