API Docs / Schemas / CreateCalendarSubscriptionRequest

CreateCalendarSubscriptionRequest

Request to subscribe to an external calendar by ICS URL. The URL is validated by fetching it,
so a bad link fails here rather than creating a broken subscription.

Properties

Name Type Description
url*string

The ICS feed URL — https:// or webcal:// (Google's "Secret address in iCal format",
Outlook's published ICS link, or Apple's public calendar link).

The ICS feed URL — https:// or webcal:// (Google's "Secret address in iCal format",
Outlook's published ICS link, or Apple's public calendar link).

namestring

Display name. When omitted, the feed's own calendar name is used.

Display name. When omitted, the feed's own calendar name is used.

color*string

Hex display colour for events from this calendar (e.g. "#3B82F6").

Hex display colour for events from this calendar (e.g. "#3B82F6").

JSON Example

{
  "url": "string",
  "name": "string",
  "color": "string"
}

Used By Operations