Zoom Public API Documentation
Insert a new event to the specified calendar
POST {{baseUrl}}/calendars/:calId/events?sendUpdates=none
Creates an event. Scopes: Rate Limit Label: calendar:write,calendar:write:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
sendUpdates
|
string | Whether to send notifications about the creation of the new event. Note that some emails might still be sent. |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"start": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"end": {
"date": "<date>",
"dateTime": "<dateTime>",
"timeZone": "<string>"
},
"attendees": [
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"organizer": "<boolean>",
"optional": "<boolean>",
"self": "<boolean>",
"resource": "<boolean>",
"responseStatus": "tentative"
},
{
"email": "<email>",
"additionalGuests": "<integer>",
"displayName": "<string>",
"organizer": "<boolean>",
"optional": "<boolean>",
"self": "<boolean>",
"resource": "<boolean>",
"responseStatus": "declined"
}
],
"colorId": "<string>",
"description": "<string>",
"guestsCanInviteOthers": "<boolean>",
"guestsCanModify": "<boolean>",
"guestsCanSeeOtherGuests": "<boolean>",
"location": "<string>",
"recurrence": [
"<string>",
"<string>"
],
"reminders": {
"useDefault": "<boolean>",
"overrides": [
{
"method": "popup",
"minutes": "<integer>"
},
{
"method": "popup",
"minutes": "<integer>"
}
]
},
"status": "cancelled",
"summary": "<string>",
"transparency": "transparent",
"visibility": "private",
"id": "<string>",
"created": "<string>",
"creator": {
"email": "<string>"
},
"organizer": {
"email": "<string>"
},
"kind": "<string>",
"updated": "<string>"
} |
Curl
curl -X POST 'https://api.zoom.us/v2/calendars/:calId/events?sendUpdates=none?sendUpdates=none' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"end":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"start":{"date":"\u003cdate\u003e","dateTime":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e"},"attendees":[{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"needsAction"},{"email":"\u003cemail\u003e","additionalGuests":"\u003cinteger\u003e","displayName":"\u003cstring\u003e","optional":"\u003cboolean\u003e","resource":"\u003cboolean\u003e","responseStatus":"accepted"}],"colorId":"\u003cstring\u003e","description":"\u003cstring\u003e","guestsCanInviteOthers":"\u003cboolean\u003e","guestsCanModify":"\u003cboolean\u003e","guestsCanSeeOtherGuests":"\u003cboolean\u003e","location":"\u003cstring\u003e","recurrence":["\u003cstring\u003e","\u003cstring\u003e"],"reminders":{"useDefault":"\u003cboolean\u003e","overrides":[{"method":"email","minutes":"\u003cinteger\u003e"},{"method":"popup","minutes":"\u003cinteger\u003e"}]},"status":"cancelled","summary":"\u003cstring\u003e","transparency":"opaque","visibility":"default"}'
ENDPOINTS