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

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 password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]. Max of 10 characters.

agenda
string

Webinar description.

tracking_fields
array[object]

Tracking fields

recurrence
object

Recurrence object.

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. Once a Webinar ends, the value of uuid for the same webinar will be different from when it was scheduled.

id
integer

Webinar ID, also known as the webinar number.

host_id
string

ID of the user set as host of the webinar.

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.

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

Join URL.

tracking_fields
array[object]

Tracking fields

occurrences
array[object]

Array of occurrence objects.

settings
object

Webinar settings.

recurrence
object

Recurrence object.

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