Logo
Zoom Public API Documentation

Get Started Fast: Meetings & Webinars-Get, Create, Update, Delete Meeting/Webinar

Number of APIs: 9


1. Create a meeting

POST {{baseUrl}}/users/:userId/meetings

Use this API to create a meeting for a user. For user-level apps, pass the me value instead of the userId parameter.

  • A meeting's start_url value is the URL a host or an alternative host can use to start a meeting. The expiration time for the start_url value is two hours for all regular users.
  • For custCreate meeting hosts (users created with the custCreate parameter via the Create users API), the expiration time of the start_url parameter is 90 days from the generation of the start_url.

Note:

For security reasons, the recommended way to programmatically (after expiry) get the updated start_url value is to call the Get a meeting API. Refer to the start_url value in the response.

Scopes: meeting:write:admin, meeting:write

Rate Limit Label: Medium
* This API has a daily rate limit of 100 requests per day. The rate limit is applied against the userId of the meeting host used to make the request.



2. Delete a meeting

DELETE {{baseUrl}}/meetings/:meetingId?schedule_for_reminder=true&cancel_meeting_reminder=true

Delete a meeting.

Scopes: meeting:write:admin meeting:write

Rate Limit Label: Light



3. Get a webinar

GET {{baseUrl}}/webinars/:webinarId?occurrence_id=<string>&show_previous_occurrences=<boolean>

Get details for a scheduled Zoom Webinar.

Prerequisites: * Pro or higher plan with a Webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT



4. Delete a webinar

DELETE {{baseUrl}}/webinars/:webinarId?occurrence_id=<string>&cancel_webinar_reminder=<boolean>

Delete a webinar.

Prerequisites:

  • Pro or higher plan with the webinar add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT



5. Update a webinar

PATCH {{baseUrl}}/webinars/:webinarId?occurrence_id=<string>

Make updates to a scheduled webinar.

100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request.

Prerequisites * A Pro or higher plan with a webinar add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT



6. List meetings

GET {{baseUrl}}/users/:userId/meetings?type=scheduled&page_size=30&next_page_token=IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2&page_number=1

Use this API to list a user's (meeting host) scheduled meetings. For user-level apps, pass the me value instead of the userId parameter.

Note: * This API only supports scheduled meetings. This API does not return information about instant meetings. * This API only returns a user's unexpired meetings.

Scopes: meeting:read:admin, meeting:read
Rate Limit Label: Medium



7. Get a meeting

GET {{baseUrl}}/meetings/:meetingId?occurrence_id=1648194360000&show_previous_occurrences=true

Retrieve the details of a meeting.

Scopes: meeting:read:admin meeting:read

Rate Limit Label: Light



8. Update a meeting

PATCH {{baseUrl}}/meetings/:meetingId?occurrence_id=1648194360000

Use this API to update a meeting's details.

Note: * This API has a rate limit of 100 requests per day. Because of this, a meeting can only be updated for a maximum of 100 times within a 24-hour period. * The start_time value must be a future date. If the value is omitted or a date in the past, the API ignores this value and will not update any recurring meetings. * If the start_time value is a future date, the recurrence object is required.

Scopes: meeting:write:admin, meeting:write
Rate Limit Label: Light



9. List webinars

GET {{baseUrl}}/users/:userId/webinars?type=scheduled&page_size=30&page_number=1

List all the webinars scheduled by or on behalf a webinar host. For user-level apps, pass the me value instead of the userId parameter.

Zoom users with a webinar plan have access to creating and managing webinars. Webinars let a host broadcast a Zoom meeting to up to 10,000 attendees.

Note This API only returns a user's unexpired webinars.

Prerequisites * A Pro or higher plan with the webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM



ENDPOINTS