Create a webinar

POST {{baseUrl}}/users/:userId/webinars

Schedule a webinar for a user who is a webinar host. For user-level apps, pass the me value instead of the userId parameter.

Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees.

Rate limit: Up to a maximum of 100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request.

Prerequisites: * A Pro or higher plan with a Webinar plan add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Request Body

{"agenda"=>"<string>", "duration"=>"<integer>", "password"=>"<string>", "recurrence"=>{"type"=>2, "end_date_time"=>"<dateTime>", "end_times"=>1, "monthly_day"=>"<integer>", "monthly_week"=>1, "monthly_week_day"=>5, "repeat_interval"=>"<integer>", "weekly_days"=>"<string>"}, "schedule_for"=>"<string>", "settings"=>{"allow_multiple_devices"=>"<boolean>", "alternative_hosts"=>"<string>", "alternative_host_update_polls"=>"<boolean>", "approval_type"=>2, "attendees_and_panelists_reminder_email_notification"=>{"enable"=>"<boolean>", "type"=>5}, "audio"=>"both", "audio_conference_info"=>"<string>", "authentication_domains"=>"<string>", "authentication_option"=>"<string>", "auto_recording"=>"none", "close_registration"=>"<boolean>", "contact_email"=>"<string>", "contact_name"=>"<string>", "email_language"=>"<string>", "enforce_login"=>"<boolean>", "enforce_login_domains"=>"<string>", "follow_up_absentees_email_notification"=>{"enable"=>"<boolean>", "type"=>1}, "follow_up_attendees_email_notification"=>{"enable"=>"<boolean>", "type"=>1}, "global_dial_in_countries"=>["<string>", "<string>"], "hd_video"=>false, "hd_video_for_attendees"=>false, "host_video"=>"<boolean>", "language_interpretation"=>{"enable"=>"<boolean>", "interpreters"=>[{"email"=>"<email>", "languages"=>"<string>"}, {"email"=>"<email>", "languages"=>"<string>"}]}, "sign_language_interpretation"=>{"enable"=>"<boolean>", "interpreters"=>[{"email"=>"<email>", "sign_language"=>"<string>"}, {"email"=>"<email>", "sign_language"=>"<string>"}]}, "panelist_authentication"=>"<boolean>", "meeting_authentication"=>"<boolean>", "add_watermark"=>"<boolean>", "add_audio_watermark"=>"<boolean>", "on_demand"=>false, "panelists_invitation_email_notification"=>"<boolean>", "panelists_video"=>"<boolean>", "post_webinar_survey"=>"<boolean>", "practice_session"=>false, "question_and_answer"=>{"allow_submit_questions"=>"<boolean>", "allow_anonymous_questions"=>"<boolean>", "answer_questions"=>"only", "attendees_can_comment"=>"<boolean>", "attendees_can_upvote"=>"<boolean>", "allow_auto_reply"=>"<boolean>", "auto_reply_text"=>"<string>", "enable"=>"<boolean>"}, "registrants_email_notification"=>"<boolean>", "registrants_restrict_number"=>0, "registration_type"=>1, "send_1080p_video_to_attendees"=>false, "show_share_button"=>"<boolean>", "survey_url"=>"<string>", "enable_session_branding"=>"<boolean>"}, "start_time"=>"<dateTime>", "template_id"=>"<string>", "timezone"=>"<string>", "topic"=>"<string>", "tracking_fields"=>[{"field"=>"<string>", "value"=>"<string>"}, {"field"=>"<string>", "value"=>"<string>"}], "type"=>5, "is_simulive"=>"<boolean>", "record_file_id"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;host_email&quot;:&quot;\u003cemail\u003e&quot;,&quot;host_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;registrants_confirmation_email&quot;:&quot;\u003cboolean\u003e&quot;,&quot;template_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;uuid&quot;:&quot;\u003cstring\u003e&quot;,&quot;agenda&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;duration&quot;:&quot;\u003cinteger\u003e&quot;,&quot;join_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;occurrences&quot;:[{&quot;duration&quot;:&quot;\u003cinteger\u003e&quot;,&quot;occurrence_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;start_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;status&quot;:&quot;deleted&quot;},{&quot;duration&quot;:&quot;\u003cinteger\u003e&quot;,&quot;occurrence_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;start_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;status&quot;:&quot;available&quot;}],&quot;password&quot;:&quot;\u003cstring\u003e&quot;,&quot;encrypted_passcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;h323_passcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;recurrence&quot;:{&quot;type&quot;:1,&quot;end_date_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;end_times&quot;:1,&quot;monthly_day&quot;:&quot;\u003cinteger\u003e&quot;,&quot;monthly_week&quot;:2,&quot;monthly_week_day&quot;:7,&quot;repeat_interval&quot;:&quot;\u003cinteger\u003e&quot;,&quot;weekly_days&quot;:&quot;\u003cstring\u003e&quot;},&quot;settings&quot;:{&quot;allow_multiple_devices&quot;:&quot;\u003cboolean\u003e&quot;,&quot;alternative_hosts&quot;:&quot;\u003cstring\u003e&quot;,&quot;alternative_host_update_polls&quot;:&quot;\u003cboolean\u003e&quot;,&quot;approval_type&quot;:2,&quot;attendees_and_panelists_reminder_email_notification&quot;:{&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:4},&quot;audio&quot;:&quot;both&quot;,&quot;audio_conference_info&quot;:&quot;\u003cstring\u003e&quot;,&quot;authentication_domains&quot;:&quot;\u003cstring\u003e&quot;,&quot;authentication_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;authentication_option&quot;:&quot;\u003cstring\u003e&quot;,&quot;auto_recording&quot;:&quot;none&quot;,&quot;close_registration&quot;:&quot;\u003cboolean\u003e&quot;,&quot;contact_email&quot;:&quot;\u003cstring\u003e&quot;,&quot;contact_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;email_language&quot;:&quot;\u003cstring\u003e&quot;,&quot;enforce_login&quot;:&quot;\u003cboolean\u003e&quot;,&quot;enforce_login_domains&quot;:&quot;\u003cstring\u003e&quot;,&quot;follow_up_absentees_email_notification&quot;:{&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:1},&quot;follow_up_attendees_email_notification&quot;:{&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:3},&quot;global_dial_in_countries&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;hd_video&quot;:false,&quot;hd_video_for_attendees&quot;:false,&quot;host_video&quot;:&quot;\u003cboolean\u003e&quot;,&quot;language_interpretation&quot;:{&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;interpreters&quot;:[{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;languages&quot;:&quot;\u003cstring\u003e&quot;},{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;languages&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;sign_language_interpretation&quot;:{&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;interpreters&quot;:[{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;sign_language&quot;:&quot;\u003cstring\u003e&quot;},{&quot;email&quot;:&quot;\u003cemail\u003e&quot;,&quot;sign_language&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;panelist_authentication&quot;:&quot;\u003cboolean\u003e&quot;,&quot;meeting_authentication&quot;:&quot;\u003cboolean\u003e&quot;,&quot;add_watermark&quot;:&quot;\u003cboolean\u003e&quot;,&quot;add_audio_watermark&quot;:&quot;\u003cboolean\u003e&quot;,&quot;notify_registrants&quot;:&quot;\u003cboolean\u003e&quot;,&quot;on_demand&quot;:false,&quot;panelists_invitation_email_notification&quot;:&quot;\u003cboolean\u003e&quot;,&quot;panelists_video&quot;:&quot;\u003cboolean\u003e&quot;,&quot;post_webinar_survey&quot;:&quot;\u003cboolean\u003e&quot;,&quot;practice_session&quot;:false,&quot;question_and_answer&quot;:{&quot;allow_submit_questions&quot;:&quot;\u003cboolean\u003e&quot;,&quot;allow_anonymous_questions&quot;:&quot;\u003cboolean\u003e&quot;,&quot;answer_questions&quot;:&quot;all&quot;,&quot;attendees_can_comment&quot;:&quot;\u003cboolean\u003e&quot;,&quot;attendees_can_upvote&quot;:&quot;\u003cboolean\u003e&quot;,&quot;allow_auto_reply&quot;:&quot;\u003cboolean\u003e&quot;,&quot;auto_reply_text&quot;:&quot;\u003cstring\u003e&quot;,&quot;enable&quot;:&quot;\u003cboolean\u003e&quot;},&quot;registrants_confirmation_email&quot;:&quot;\u003cboolean\u003e&quot;,&quot;registrants_email_notification&quot;:&quot;\u003cboolean\u003e&quot;,&quot;registrants_restrict_number&quot;:0,&quot;registration_type&quot;:1,&quot;send_1080p_video_to_attendees&quot;:false,&quot;show_share_button&quot;:&quot;\u003cboolean\u003e&quot;,&quot;survey_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;enable_session_branding&quot;:&quot;\u003cboolean\u003e&quot;},&quot;start_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;start_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;topic&quot;:&quot;\u003cstring\u003e&quot;,&quot;tracking_fields&quot;:[{&quot;field&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;field&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;type&quot;:5,&quot;is_simulive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;record_file_id&quot;:&quot;\u003cstring\u003e&quot;}