Logo
Zoom Public API Documentation

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

 

Body PARAM

Key Datatype Required Description 
colorRgbFormat
string This parameter must be set to true when user wants to change the foreground or background color.



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status OK

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



Curl
curl -X PATCH 'https://api.zoom.us/v2/calendars/users/:userIdentifier/calendarList/:calendarId?colorRgbFormat=<boolean>?colorRgbFormat=<boolean>' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"id":"\u003cemail\u003e","summary":"\u003cstring\u003e","description":"\u003cstring\u003e","location":"\u003cstring\u003e","timeZone":"\u003cstring\u003e","colorId":"\u003cstring\u003e","backgroundColor":"\u003cstring\u003e","foregroundColor":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","selected":"\u003cboolean\u003e","accessRole":"freeBusyReader","defaultReminders":[{"method":"email","minutes":"\u003cinteger\u003e"},{"method":"email","minutes":"\u003cinteger\u003e"}],"defaultAllDayReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"notificationSettings":{"notifications":[{"type":"agenda","method":"email"},{"type":"eventCancellation","method":"email"}]},"primary":"\u003cboolean\u003e","deleted":"\u003cboolean\u003e","summaryOverride":"\u003cstring\u003e"}'

ENDPOINTS