Inserts an existing calendar into the user's calendar list.
Query parameters
Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False
Request body
Title of the calendar. Read-only
The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional
Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true
The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional
Type of the resource ("calendar#calendarListEntry")
Description of the calendar. Optional. Read-only
The time zone of the calendar. Optional. Read-only
The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False
The summary that the authenticated user has set for this calendar. Optional
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- "freeBusyReader" - Provides read access to free/busy information.
- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs
ETag of the resource
Geographic location of the calendar as free-form text. Optional. Read-only
Identifier of the calendar
Whether the calendar content shows up in the calendar UI. Optional. The default is False
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False
Response
A gcalendar:CalendarListEntry if successful, otherwise an error
Title of the calendar. Read-only
The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional
Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true
The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional
Type of the resource ("calendar#calendarListEntry")
Description of the calendar. Optional. Read-only
The time zone of the calendar. Optional. Read-only
The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False
The summary that the authenticated user has set for this calendar. Optional
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- "freeBusyReader" - Provides read access to free/busy information.
- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs
ETag of the resource
Geographic location of the calendar as free-form text. Optional. Read-only
Identifier of the calendar
Whether the calendar content shows up in the calendar UI. Optional. The default is False
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False