Create a calendar by the iCal link
POST /api/2.0/calendar/calendarUrlRequest
Creates a calendar by the link to the external iCal feed.
Note: Please note that the list of events in the response will be empty.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.
Headers
- Accept
enum of string Can be one of:
application/json.- Content-Type
enum of string Can be one of:
application/json.
Body
- iCalUrl
string Link to the external iCal feed
- name
string Calendar name
- textColor
string Event text color
- backgroundColor
string Event background name
Examples
POST /api/2.0/calendar/calendarUrl HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.comcurl --request POST \
--url https://example.com/api/2.0/calendar/calendarUrl \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Responses
200
Created calendar
- IsSubscription
boolean - iCalUrl
string - IsiCalStream
boolean - IsHidden
boolean - CanAlertModify
boolean - IsShared
boolean - Permissions
object - Data
object - AvailableOptions
array of object - Id
string - Name
string - Default
boolean - DefaultStyle
string
- Items
array of object - ItemId
string - ItemName
string - IsGroup
boolean - CanEdit
boolean - SharingOption
object - Id
string - Name
string - Default
boolean - DefaultStyle
string
- UserParams
array of object - Id
stringformat: uuid - Name
string
- IsEditable
boolean - TextColor
string - BackgroundColor
string - Description
string - Title
string - Id
string - IsTodo
integerformat: int32 - Owner
object - Id
stringformat: uuid - Name
string
- Events
array of object - Id
string - Uid
string - CalendarId
string - Name
string - Description
string - AllDayLong
boolean - Start
string - End
string - RepeatRule
string - Alert
object - Type
integerformat: int32
- IsShared
boolean - CanUnsubscribe
boolean - IsEditable
boolean - Permissions
object - UserParams
array of object - Id
stringformat: uuid - Name
string
- Owner
object - Id
stringformat: uuid - Name
string
- Status
enum of integerformat: int32 [0 - Tentative, 1 - Confirmed, 2 - Cancelled]
Can be one of:
Tentative,Confirmed,Cancelled.- HasAttachments
boolean
- Todos
array of object - Id
string - Uid
string - CalendarId
string - Name
string - Description
string - Start
string - Completed
string - Owner
object - Id
stringformat: uuid - Name
string
- DefaultAlertType
object - Type
integerformat: int32
- TimeZoneInfo
object - Name
string - Id
string - Offset
integerformat: int32
- CanEditTimeZone
boolean
401
Unauthorized