Upsert calendar event

Create or update a calendar event (holiday or workday override). Omit event_id to create a new event.

POST /calendar/event/upsert

Upsert calendar event

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

200

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

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	Calendars Manage (on-call)

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

Calendar event upsert request. Provide event_id to update an existing event; omit it to create a new one.

cal_id · string · required

Calendar ID.

summary · string · required

Event summary.

Required string length: 1 - 39

start_at · string · required

Event start date in YYYY-MM-DD.

end_at · string · required

Event end date in YYYY-MM-DD (exclusive).

is_off · boolean | null · required

Whether the event marks a non-working day. true = day off, false = working day override.

event_id · string

Event ID. Omit when creating.

Maximum string length: 63

description · string

Event description.

Maximum string length: 499

Response

200

application/json

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

Response returned by /calendar/event/upsert.

Show child attributes