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
post

/users/{userId}/webinars

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 schedule a Webinar for a user (host).

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

Request Body

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. We support two formats for start_time - local time and GMT.

To set time as GMT the format should be yyyy-MM-ddTHH:mm:ssZ.

To set time using a specific timezone, use yyyy-MM-ddTHH:mm:ss format and specify the timezone ID in the timezone field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field.

The start_time should only be used for scheduled and / or recurring webinars with fixed time.

1 validation
duration
integer

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

timezone
string

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

password
string

Webinar passcode. Passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]. Max of 10 characters.

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.

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 Get Account Settings API.

agenda
string

Webinar description.

tracking_fields
array[object]

Tracking fields

recurrence
object

Recurrence object. Use this object only for a webinar of type 9 i.e., a recurring webinar with fixed time.

settings
object

Create Webinar settings.

Responses

HTTP Status Code: 201
Webinar created.

1 Header
1 Example
Schema
object

Webinar object.

uuid
string

Unique identifier for a Webinar. Each Webinar instance will generate its own UUID(i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Once a Webinar ends, the value of uuid for the same webinar will be different from when it was scheduled.

id
integer

Webinar ID in “long” format(represented as int64 data type in JSON), also known as the webinar number.

1 validation
host_id
string

ID of the user set as host of the webinar.

host_email
string

Email address of the meeting host.

1 validation
registrants_confirmation_email
boolean

Specify whether or not registrants of this Webinar should receieve confirmation emails.

template_id
string

Unique identifier of the Webinar template. Use this field only if you would like to schedule the webinar using an existing template. The value of this field can be retrieved from List

topic
string

Webinar topic.

1 validation
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 GMT/UTC.

1 validation
duration
integer

Webinar duration.

timezone
string

Time zone to format start_time.

agenda
string

Webinar agenda.

created_at
string

Create time.

1 validation
start_url
string





join_url
string

URL to join the Webinar. This URL should only be shared with the users who should be invited to the Webinar.

tracking_fields
array[object]

Tracking fields

occurrences
array[object]

Array of occurrence objects.

settings
object

Webinar settings.

recurrence
object

Recurrence object. Use this object only for a webinar of type 9 i.e., a recurring webinar with fixed time.

password
string

Webinar passcode.

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.

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.

1 validation

Send a Test Request

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