Logo
Zoom Public API Documentation

Insert an existing calendar to the user's own calendarList

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

Inserts an existing calendar into the user's calendar list. The user can be me or a given calendar ID.

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 the 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": "email", "minutes": "<integer>" } ], "defaultAllDayReminders": [ { "method": "popup", "minutes": "<integer>" }, { "method": "email", "minutes": "<integer>" } ], "notificationSettings": { "notifications": [ { "type": "eventCreation", "method": "email" }, { "type": "eventChange", "method": "email" } ] }, "primary": "<boolean>", "deleted": "<boolean>", "summaryOverride": "<string>" }



Curl
curl -X POST 'https://api.zoom.us/v2/calendars/users/:userIdentifier/calendarList?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":"reader","defaultReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"defaultAllDayReminders":[{"method":"popup","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}],"notificationSettings":{"notifications":[{"type":"eventCancellation","method":"email"},{"type":"eventCancellation","method":"email"}]},"primary":"\u003cboolean\u003e","deleted":"\u003cboolean\u003e","summaryOverride":"\u003cstring\u003e"}'

ENDPOINTS