Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Account Events
App Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
patch

/webinars/{webinarId}

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to make updates to a scheduled Webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

  • Pro or higher plan with a Webinar Add-on.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Request Body

Webinar.

1 Example
Schema
object

Webinar object

topic
string

Webinar topic.

type
integer

Webinar Types:
5 - webinar.
6 - Recurring webinar with no fixed time.
9 - Recurring webinar with a fixed time.

3 validations
start_time
string

Webinar start time, in the format “yyyy-MM-dd’T’HH:mm:ss’Z’.” Should be in GMT time. In the format “yyyy-MM-dd’T’HH:mm:ss.” This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.

1 validation
duration
integer

Webinar duration (minutes). Used for scheduled webinar only.

timezone
string

Time zone to format start_time. For example, “America/Los_Angeles”. For scheduled meetings only. Please reference our time zone list for supported time zones and their formats.

password
string

Webinar passcode. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ * !] and can have a maximum of 10 characters.

Note: If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements.

If the requirements are enabled, you can view those requirements by calling either the Get User Settings API or the Get Account Settings API.

If “Require a passcode when scheduling new meetings” setting has been enabled and locked for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request.

1 validation
agenda
string

Webinar description.

tracking_fields
array[object]

Tracking fields

recurrence
object

Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.

settings
object

Webinar settings.

Responses

HTTP Status Code: 200
Webinar subscription plan is missing. Enable webinar for this user once the subscription is added:{userId}.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
webinarId
$$.env
1 variable not set
oauth_access_token