CalendarSubscriptionDto
One of the current user's external calendar subscriptions.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique code identifying the subscription. |
Unique code identifying the subscription. | ||
| name | string | Display name for the calendar. |
Display name for the calendar. | ||
| color | string | Hex display colour for events from this calendar (e.g. "#3B82F6"). |
Hex display colour for events from this calendar (e.g. "#3B82F6"). | ||
| url | string | The ICS feed URL. A secret-address URL grants read access to the source calendar, so |
The ICS feed URL. A secret-address URL grants read access to the source calendar, so | ||
| isVisible | boolean | Whether events from this calendar are currently shown on the task calendar. |
Whether events from this calendar are currently shown on the task calendar. | ||
| lastFetchedAt | string | When the feed was last actually fetched from the source. |
When the feed was last actually fetched from the source. | ||
| lastFetchStatus | enum | NeverFetched Ok Failed |
NeverFetched Ok Failed | ||
| lastFetchError | string | Why the most recent fetch failed. Null while the feed is healthy. |
Why the most recent fetch failed. Null while the feed is healthy. | ||
| createdDate | string | When the subscription was created. |
When the subscription was created. | ||
| updatedDate | string | When the subscription was last edited. Null if never edited. |
When the subscription was last edited. Null if never edited. | ||
JSON Example
{
"code": "string",
"name": "string",
"color": "string",
"url": "string",
"isVisible": false
}
Used By Operations
-
POST
Create Calendar Subscription
/tenants/{tenant}/calendar-subscriptions
-
GET
Get Calendar Subscription
/tenants/{tenant}/calendar-subscriptions/{code}
-
PUT
Update Calendar Subscription
/tenants/{tenant}/calendar-subscriptions/{code}
-
POST
Refresh Calendar Subscription
/tenants/{tenant}/calendar-subscriptions/{code}/refresh