Calendar API
  1. calendarList
Calendar API
  • calendars
    • /calendars
      POST
    • /calendars/{calendarId}
      DELETE
    • /calendars/{calendarId}
      GET
    • /calendars/{calendarId}
      PATCH
    • /calendars/{calendarId}
      PUT
    • /calendars/{calendarId}/clear
      POST
  • acl
    • /calendars/{calendarId}/acl
      GET
    • /calendars/{calendarId}/acl
      POST
    • /calendars/{calendarId}/acl/watch
      POST
    • /calendars/{calendarId}/acl/{ruleId}
      DELETE
    • /calendars/{calendarId}/acl/{ruleId}
      GET
    • /calendars/{calendarId}/acl/{ruleId}
      PATCH
    • /calendars/{calendarId}/acl/{ruleId}
      PUT
  • events
    • /calendars/{calendarId}/events
      GET
    • /calendars/{calendarId}/events
      POST
    • /calendars/{calendarId}/events/import
      POST
    • /calendars/{calendarId}/events/quickAdd
      POST
    • /calendars/{calendarId}/events/watch
      POST
    • /calendars/{calendarId}/events/{eventId}
      DELETE
    • /calendars/{calendarId}/events/{eventId}
      GET
    • /calendars/{calendarId}/events/{eventId}
      PATCH
    • /calendars/{calendarId}/events/{eventId}
      PUT
    • /calendars/{calendarId}/events/{eventId}/instances
      GET
    • /calendars/{calendarId}/events/{eventId}/move
      POST
  • channels
    • /channels/stop
  • colors
    • /colors
  • freebusy
    • /freeBusy
  • calendarList
    • /users/me/calendarList
      GET
    • /users/me/calendarList
      POST
    • /users/me/calendarList/watch
      POST
    • /users/me/calendarList/{calendarId}
      DELETE
    • /users/me/calendarList/{calendarId}
      GET
    • /users/me/calendarList/{calendarId}
      PATCH
    • /users/me/calendarList/{calendarId}
      PUT
  • settings
    • /users/me/settings
    • /users/me/settings/watch
    • /users/me/settings/{setting}
  1. calendarList

/users/me/calendarList/{calendarId}

PUT
/users/me/calendarList/{calendarId}
calendarList
Updates an existing calendar on the user's calendar list.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://www.googleapis.com/calendar/v3/users/me/calendarList/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accessRole": "string",
    "backgroundColor": "string",
    "colorId": "string",
    "conferenceProperties": {
        "allowedConferenceSolutionTypes": [
            "string"
        ]
    },
    "defaultReminders": [
        {
            "method": "string",
            "minutes": 0
        }
    ],
    "deleted": false,
    "description": "string",
    "etag": "string",
    "foregroundColor": "string",
    "hidden": false,
    "id": "string",
    "kind": "calendar#calendarListEntry",
    "location": "string",
    "notificationSettings": {
        "notifications": [
            {
                "method": "string",
                "type": "string"
            }
        ]
    },
    "primary": false,
    "selected": false,
    "summary": "string",
    "summaryOverride": "string",
    "timeZone": "string"
}'
Response Response Example
{
  "accessRole": "string",
  "backgroundColor": "string",
  "colorId": "string",
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      "string"
    ]
  },
  "defaultReminders": [
    {
      "method": "string",
      "minutes": 0
    }
  ],
  "deleted": false,
  "description": "string",
  "etag": "string",
  "foregroundColor": "string",
  "hidden": false,
  "id": "string",
  "kind": "calendar#calendarListEntry",
  "location": "string",
  "notificationSettings": {
    "notifications": [
      {
        "method": "string",
        "type": "string"
      }
    ]
  },
  "primary": false,
  "selected": false,
  "summary": "string",
  "summaryOverride": "string",
  "timeZone": "string"
}

Request

Path Params
calendarId
string 
required
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Query Params
colorRgbFormat
string 
optional
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.
Body Params application/json
accessRole
string 
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.
backgroundColor
string 
optional
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.
colorId
string 
optional
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.
conferenceProperties
object (ConferenceProperties) 
optional
Conferencing properties for this calendar, for example what types of conferences are allowed.
allowedConferenceSolutionTypes
array[string]
optional
The types of conference solutions that are supported for this calendar.
The possible values are:
"eventHangout"
"eventNamedHangout"
"hangoutsMeet" Optional.
defaultReminders
array[object (EventReminder) {2}] 
optional
The default reminders that the authenticated user has for this calendar.
method
string 
optional
The method used by this reminder. Possible values are:
"email" - Reminders are sent via email.
"popup" - Reminders are sent via a UI popup.
Required when adding a reminder.
minutes
integer <int32>
optional
Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder.
deleted
boolean 
optional
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
Default:
false
description
string 
optional
Description of the calendar. Optional. Read-only.
etag
string 
optional
ETag of the resource.
foregroundColor
string 
optional
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.
hidden
boolean 
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.
Default:
false
id
string 
optional
Identifier of the calendar.
kind
string 
optional
Type of the resource ("calendar#calendarListEntry").
Default:
calendar#calendarListEntry
location
string 
optional
Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettings
object 
optional
The notifications that the authenticated user is receiving for this calendar.
notifications
array[object (CalendarNotification) {2}] 
optional
The list of notifications set for this calendar.
primary
boolean 
optional
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
Default:
false
selected
boolean 
optional
Whether the calendar content shows up in the calendar UI. Optional. The default is False.
Default:
false
summary
string 
optional
Title of the calendar. Read-only.
summaryOverride
string 
optional
The summary that the authenticated user has set for this calendar. Optional.
timeZone
string 
optional
The time zone of the calendar. Optional. Read-only.
Examples

Responses

🟢200Successful response
application/json
Body
accessRole
string 
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.
backgroundColor
string 
optional
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.
colorId
string 
optional
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.
conferenceProperties
object (ConferenceProperties) 
optional
Conferencing properties for this calendar, for example what types of conferences are allowed.
allowedConferenceSolutionTypes
array[string]
optional
The types of conference solutions that are supported for this calendar.
The possible values are:
"eventHangout"
"eventNamedHangout"
"hangoutsMeet" Optional.
defaultReminders
array[object (EventReminder) {2}] 
optional
The default reminders that the authenticated user has for this calendar.
method
string 
optional
The method used by this reminder. Possible values are:
"email" - Reminders are sent via email.
"popup" - Reminders are sent via a UI popup.
Required when adding a reminder.
minutes
integer <int32>
optional
Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder.
deleted
boolean 
optional
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
Default:
false
description
string 
optional
Description of the calendar. Optional. Read-only.
etag
string 
optional
ETag of the resource.
foregroundColor
string 
optional
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.
hidden
boolean 
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.
Default:
false
id
string 
optional
Identifier of the calendar.
kind
string 
optional
Type of the resource ("calendar#calendarListEntry").
Default:
calendar#calendarListEntry
location
string 
optional
Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettings
object 
optional
The notifications that the authenticated user is receiving for this calendar.
notifications
array[object (CalendarNotification) {2}] 
optional
The list of notifications set for this calendar.
primary
boolean 
optional
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
Default:
false
selected
boolean 
optional
Whether the calendar content shows up in the calendar UI. Optional. The default is False.
Default:
false
summary
string 
optional
Title of the calendar. Read-only.
summaryOverride
string 
optional
The summary that the authenticated user has set for this calendar. Optional.
timeZone
string 
optional
The time zone of the calendar. Optional. Read-only.
Previous
/users/me/calendarList/{calendarId}
Next
/users/me/settings
Built with