Update an existing calendar in the user's own calendarList

PATCH {{baseUrl}}/calendars/users/:userIdentifier/calendarList/:calendarId?colorRgbFormat=<boolean>

Updates an existing calendar on the user's calendar list.

Scopes: calendar:write,calendar:write:admin

Rate Limit Label: LIGHT

Request Params

KeyDatatypeRequiredDescription
colorRgbFormatstringThis parameter must be set to true when user wants to change the foreground or background color.

Request Body

{"id"=>"<email>", "summary"=>"<string>", "description"=>"<string>", "location"=>"<string>", "timeZone"=>"<string>", "colorId"=>"<string>", "backgroundColor"=>"<string>", "foregroundColor"=>"<string>", "hidden"=>"<boolean>", "selected"=>"<boolean>", "accessRole"=>"freeBusyReader", "defaultReminders"=>[{"method"=>"email", "minutes"=>"<integer>"}, {"method"=>"email", "minutes"=>"<integer>"}], "defaultAllDayReminders"=>[{"method"=>"popup", "minutes"=>"<integer>"}, {"method"=>"popup", "minutes"=>"<integer>"}], "notificationSettings"=>{"notifications"=>[{"type"=>"agenda", "method"=>"email"}, {"type"=>"eventCancellation", "method"=>"email"}]}, "primary"=>"<boolean>", "deleted"=>"<boolean>", "summaryOverride"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;id&quot;:&quot;\u003cemail\u003e&quot;,&quot;kind&quot;:&quot;\u003cstring\u003e&quot;,&quot;etag&quot;:&quot;\u003cstring\u003e&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;timeZone&quot;:&quot;\u003cstring\u003e&quot;,&quot;colorId&quot;:&quot;\u003cstring\u003e&quot;,&quot;backgroundColor&quot;:&quot;\u003cstring\u003e&quot;,&quot;foregroundColor&quot;:&quot;\u003cstring\u003e&quot;,&quot;hidden&quot;:&quot;\u003cboolean\u003e&quot;,&quot;selected&quot;:&quot;\u003cboolean\u003e&quot;,&quot;accessRole&quot;:&quot;reader&quot;,&quot;defaultReminders&quot;:[{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;defaultAllDayReminders&quot;:[{&quot;method&quot;:&quot;email&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;method&quot;:&quot;popup&quot;,&quot;minutes&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;notificationSettings&quot;:{&quot;notifications&quot;:[{&quot;type&quot;:&quot;eventChange&quot;,&quot;method&quot;:&quot;email&quot;},{&quot;type&quot;:&quot;agenda&quot;,&quot;method&quot;:&quot;email&quot;}]},&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;summaryOverride&quot;:&quot;\u003cstring\u003e&quot;}