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.
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webinarId |
Integer | Yes |
The webinar ID in "long" format(represented as int64 data type in JSON). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
occurrence_id |
String | No |
Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording} |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
agenda |
String | No |
Webinar description. |
timezone |
String | No |
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. |
topic |
String | No |
Webinar topic. |
tracking_fields[] |
Array | No |
Tracking fields |
tracking_fields[].field |
String | No |
Tracking fields type |
tracking_fields[].value |
String | No |
Tracking fields value |
start_time |
String | No |
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. |
recurrence |
Object | No |
Recurrence object. Use this object only for a meeting with type |
recurrence.weekly_days |
String | No |
This field is required if you're scheduling a recurring meeting of type
Valid values:
Default value: "1" |
recurrence.end_date_time |
String | No |
Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with "end_times".) |
recurrence.end_times |
Integer | No |
Select how many times the meeting should recur before it is canceled. (Cannot be used with "end_date_time".) Default value: 1 |
recurrence.type |
Integer | Yes |
Recurrence meeting types: Valid values:
|
recurrence.repeat_interval |
Integer | No |
Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as For a daily meeting, the maximum interval you can set is |
recurrence.monthly_day |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type For instance, if you would like the meeting to recur on 23rd of each month, provide Default value: 1 |
recurrence.monthly_week |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type Valid values:
|
recurrence.monthly_week_day |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type
Valid values:
|
password |
String | No |
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 "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. |
type |
Integer | No |
Webinar Types: Valid values:
Default value: 5 |
duration |
Integer | No |
Webinar duration (minutes). Used for scheduled webinar only. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.