Update calendar

Update an existing calendar. This is a full update: omitting public makes the calendar private and omitting default clears the account-default flag, so include the current values for anything you don't intend to change. Built-in calendars keep their existing name. First retrieve the calendar from /api/calendars, apply your changes, then send back the full object.

Required permission: Full Write Events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the calendar

Body Params

The new details

string | null
required

The calendar's name, up to 100 characters. Built-in calendars keep their existing name; name changes on them are ignored.

string | null
required

The calendar's display color, as a hex code (for example #6BB9F0).

boolean | null

Whether events on the calendar are publicly visible by default. Omitting it makes the calendar private.

boolean | null

Whether this is the account's default calendar. Setting true makes this calendar the default and clears the flag on every other calendar.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json