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:

Servers

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 8 i.e., a recurring meeting with fixed time.

recurrence.weekly_days String No

This field is required if you're scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.

The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.

Note: If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide "1,3" as the value of this field.


1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

  • "4"
  • "3"
  • "2"
  • "1"
  • "7"
  • "6"
  • "5"

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:
1 - Daily.
2 - Weekly.
3 - Monthly.

Valid values:

  • 1
  • 2
  • 3
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 2 and the value of the type parameter as 3.

For a daily meeting, the maximum interval you can set is 90 days. For a weekly meeting the maximum interval that you can set is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.

recurrence.monthly_day Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state which day in a month, the meeting should recur. The value range is from 1 to 31.

For instance, if you would like the meeting to recur on 23rd of each month, provide 23 as the value of this field and 1 as the value of the repeat_interval field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the repeat_interval field to 3.

Default value: 1

recurrence.monthly_week Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the meeting should recur.
-1 - Last week of the month.
1 - First week of the month.
2 - Second week of the month.
3 - Third week of the month.
4 - Fourth week of the month.

Valid values:

  • 1
  • 2
  • 3
  • -1
  • 4
recurrence.monthly_week_day Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the monthly_week field.


1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
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 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.

type Integer No

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

Valid values:

  • 5
  • 6
  • 9

Default value: 5

duration Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.