Zoom Public API Documentation
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 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 Prerequisites:
* A Pro or higher plan with a Webinar plan add-on. Scopes: Rate Limit Label: me value instead of the userId parameter. userId of the webinar host used to make the request. webinar:write,webinar:write:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status Created
| {
"host_email": "<email>",
"host_id": "<string>",
"id": "<long>",
"registrants_confirmation_email": "<boolean>",
"template_id": "<string>",
"uuid": "<string>",
"agenda": "<string>",
"created_at": "<dateTime>",
"duration": "<integer>",
"join_url": "<string>",
"occurrences": [
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "deleted"
},
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "available"
}
],
"password": "<string>",
"encrypted_passcode": "<string>",
"h323_passcode": "<string>",
"recurrence": {
"type": 1,
"end_date_time": "<dateTime>",
"end_times": 1,
"monthly_day": "<integer>",
"monthly_week": 2,
"monthly_week_day": 7,
"repeat_interval": "<integer>",
"weekly_days": "<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": 4
},
"audio": "both",
"audio_conference_info": "<string>",
"authentication_domains": "<string>",
"authentication_name": "<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": 3
},
"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>",
"notify_registrants": "<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": "all",
"attendees_can_comment": "<boolean>",
"attendees_can_upvote": "<boolean>",
"allow_auto_reply": "<boolean>",
"auto_reply_text": "<string>",
"enable": "<boolean>"
},
"registrants_confirmation_email": "<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>",
"start_url": "<string>",
"timezone": "<string>",
"topic": "<string>",
"tracking_fields": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"type": 5,
"is_simulive": "<boolean>",
"record_file_id": "<string>"
} |
Curl
curl -X POST 'https://api.zoom.us/v2/users/:userId/webinars' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"agenda":"\u003cstring\u003e","duration":"\u003cinteger\u003e","password":"\u003cstring\u003e","recurrence":{"type":2,"end_date_time":"\u003cdateTime\u003e","end_times":1,"monthly_day":"\u003cinteger\u003e","monthly_week":1,"monthly_week_day":5,"repeat_interval":"\u003cinteger\u003e","weekly_days":"\u003cstring\u003e"},"schedule_for":"\u003cstring\u003e","settings":{"allow_multiple_devices":"\u003cboolean\u003e","alternative_hosts":"\u003cstring\u003e","alternative_host_update_polls":"\u003cboolean\u003e","approval_type":2,"attendees_and_panelists_reminder_email_notification":{"enable":"\u003cboolean\u003e","type":5},"audio":"both","audio_conference_info":"\u003cstring\u003e","authentication_domains":"\u003cstring\u003e","authentication_option":"\u003cstring\u003e","auto_recording":"none","close_registration":"\u003cboolean\u003e","contact_email":"\u003cstring\u003e","contact_name":"\u003cstring\u003e","email_language":"\u003cstring\u003e","enforce_login":"\u003cboolean\u003e","enforce_login_domains":"\u003cstring\u003e","follow_up_absentees_email_notification":{"enable":"\u003cboolean\u003e","type":1},"follow_up_attendees_email_notification":{"enable":"\u003cboolean\u003e","type":1},"global_dial_in_countries":["\u003cstring\u003e","\u003cstring\u003e"],"hd_video":false,"hd_video_for_attendees":false,"host_video":"\u003cboolean\u003e","language_interpretation":{"enable":"\u003cboolean\u003e","interpreters":[{"email":"\u003cemail\u003e","languages":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","languages":"\u003cstring\u003e"}]},"sign_language_interpretation":{"enable":"\u003cboolean\u003e","interpreters":[{"email":"\u003cemail\u003e","sign_language":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","sign_language":"\u003cstring\u003e"}]},"panelist_authentication":"\u003cboolean\u003e","meeting_authentication":"\u003cboolean\u003e","add_watermark":"\u003cboolean\u003e","add_audio_watermark":"\u003cboolean\u003e","on_demand":false,"panelists_invitation_email_notification":"\u003cboolean\u003e","panelists_video":"\u003cboolean\u003e","post_webinar_survey":"\u003cboolean\u003e","practice_session":false,"question_and_answer":{"allow_submit_questions":"\u003cboolean\u003e","allow_anonymous_questions":"\u003cboolean\u003e","answer_questions":"only","attendees_can_comment":"\u003cboolean\u003e","attendees_can_upvote":"\u003cboolean\u003e","allow_auto_reply":"\u003cboolean\u003e","auto_reply_text":"\u003cstring\u003e","enable":"\u003cboolean\u003e"},"registrants_email_notification":"\u003cboolean\u003e","registrants_restrict_number":0,"registration_type":1,"send_1080p_video_to_attendees":false,"show_share_button":"\u003cboolean\u003e","survey_url":"\u003cstring\u003e","enable_session_branding":"\u003cboolean\u003e"},"start_time":"\u003cdateTime\u003e","template_id":"\u003cstring\u003e","timezone":"\u003cstring\u003e","topic":"\u003cstring\u003e","tracking_fields":[{"field":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"field":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"type":5,"is_simulive":"\u003cboolean\u003e","record_file_id":"\u003cstring\u003e"}'
ENDPOINTS