Update the calendar view
PUT /api/2.0/calendar/{calendarId}/viewRequest
Updates the calendar display parameters specified in the request for the current user.
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.
Path
- calendarId
string Calendar ID
Body
- name
string New calendar name
- textColor
string New event text color
- backgroundColor
string New event background color
- timeZone
string New calendar time zone
- alertType
integer New event alert type, in case alert type is set by default
- hideEvents
boolean Display type: show or hide events in the calendar
Examples
PUT /api/2.0/calendar/%7BcalendarId%7D/view HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.comcurl --request PUT \
--url https://example.com/api/2.0/calendar/%7BcalendarId%7D/view \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Responses
200
Updated 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