DataFlex / Zoom API / Create a webinar
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sOccurrence_id
String sStatus
String sUuid
String sId
String sHost_id
String sTopic
String sV_type
String sStart_time
String sDuration
String sTimezone
String sAgenda
String sCreated_at
String sStart_url
String sJoin_url
String sHost_video
String sPanelists_video
String sPractice_session
String sHd_video
String sHd_video_for_attendees
String sSend_1080p_video_to_attendees
String sApproval_type
String sRegistration_type
String sAudio
String sAuto_recording
String sEnforce_login
String sEnforce_login_domains
String sAlternative_hosts
String sClose_registration
String sShow_share_button
String sAllow_multiple_devices
String sEmail_language
String sPanelists_invitation_email_notification
String sRegistrants_confirmation_email
String sRegistrants_email_notification
String sEnable
String sV_Type
String sFollow_up_attendees_email_notificationEnable
String sFollow_up_attendees_email_notificationType
String sFollow_up_absentees_email_notificationEnable
String sFollow_up_absentees_email_notificationType
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "POST"
Set ComPath Of hoReq To "/v2/users/:userId/webinars"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "topic" "tempor esse"
Get ComAddStringForUpload2 Of hoReq "" "" "" "" "tempor esse5" To iSuccess
Send ComAddParam To hoReq "start_time" "tempor esse51949-08-06T23:27:19.613Z"
Send ComAddParam To hoReq "duration" "tempor esse51949-08-06T23:27:19.613Z-79092517"
Send ComAddParam To hoReq "timezone" "tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmod"
Send ComAddParam To hoReq "password" "tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit ut"
Send ComAddParam To hoReq "agenda" "tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco"
Send ComAddParam To hoReq "tracking_fields" 'tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]'
Send ComAddParam To hoReq "recurrence" 'tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}'
Send ComAddParam To hoReq "settings" 'tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}{"host_video":true,"panelists_video":true,"practice_session":false,"hd_video":false,"hd_video_for_attendees":false,"send_1080p_video_to_attendees":false,"approval_type":2,"registration_type":1,"audio":"both","auto_recording":"none","enforce_login":false,"enforce_login_domains":"dolore dolore aute laboris deserunt","alternative_hosts":"pariatur culpa cupidatat quis","close_registration":false,"show_share_button":true,"allow_multiple_devices":false,"on_demand":false,"global_dial_in_countries":["dolor","sit proident in fugiat"],"contact_name":"exercitation","contact_email":"sed ","registrants_restrict_number":0,"post_webinar_survey":false,"survey_url":"sunt ut proident tempor Duis","registrants_email_notification":false,"meeting_authentication":true,"authentication_option":"fugiat irure commodo","authentication_domains":"elit quis","question_and_answer":{"enable":false,"allow_anonymous_questions":false,"answer_questions":"all","attendees_can_upvote":false,"attendees_can_comment":false},"email_language":"adipisicing dolor","panelists_invitation_email_notification":false,"attendees_and_panelists_reminder_email_notification":{"enable":false,"type":7},"follow_up_attendees_email_notification":{"enable":false,"type":2},"follow_up_absentees_email_notification":{"enable":false,"type":3},"language_interpretation":{"enable":true,"interpreters":[{"email":"ObCA8sbYRELjrgF@sNwVXKmVZXJBMYWjGyhnvSqUxHrLGU.vb","languages":"pariatur sed sint"},{"email":"3woHM5Hht5X@Jv.ei","languages":"sunt id sit"}]}}'
Send ComAddParam To hoReq "template_id" 'tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}{"host_video":true,"panelists_video":true,"practice_session":false,"hd_video":false,"hd_video_for_attendees":false,"send_1080p_video_to_attendees":false,"approval_type":2,"registration_type":1,"audio":"both","auto_recording":"none","enforce_login":false,"enforce_login_domains":"dolore dolore aute laboris deserunt","alternative_hosts":"pariatur culpa cupidatat quis","close_registration":false,"show_share_button":true,"allow_multiple_devices":false,"on_demand":false,"global_dial_in_countries":["dolor","sit proident in fugiat"],"contact_name":"exercitation","contact_email":"sed ","registrants_restrict_number":0,"post_webinar_survey":false,"survey_url":"sunt ut proident tempor Duis","registrants_email_notification":false,"meeting_authentication":true,"authentication_option":"fugiat irure commodo","authentication_domains":"elit quis","question_and_answer":{"enable":false,"allow_anonymous_questions":false,"answer_questions":"all","attendees_can_upvote":false,"attendees_can_comment":false},"email_language":"adipisicing dolor","panelists_invitation_email_notification":false,"attendees_and_panelists_reminder_email_notification":{"enable":false,"type":7},"follow_up_attendees_email_notification":{"enable":false,"type":2},"follow_up_absentees_email_notification":{"enable":false,"type":3},"language_interpretation":{"enable":true,"interpreters":[{"email":"ObCA8sbYRELjrgF@sNwVXKmVZXJBMYWjGyhnvSqUxHrLGU.vb","languages":"pariatur sed sint"},{"email":"3woHM5Hht5X@Jv.ei","languages":"sunt id sit"}]}}minim ea sunt'
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "api.zoom.us" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "uuid": "string",
// "id": "integer",
// "host_id": "string",
// "topic": "string",
// "type": "integer",
// "start_time": "string [date-time]",
// "duration": "integer",
// "timezone": "string",
// "agenda": "string",
// "created_at": "string [date-time]",
// "start_url": "string",
// "join_url": "string",
// "occurrences": [
// {
// "occurrence_id": "integer",
// "start_time": "string [date-time]",
// "duration": "integer",
// "status": "string"
// }
// ],
// "settings": {
// "host_video": "boolean",
// "panelists_video": "boolean",
// "practice_session": "boolean",
// "hd_video": "boolean",
// "hd_video_for_attendees": "boolean",
// "send_1080p_video_to_attendees": "boolean",
// "approval_type": "integer",
// "registration_type": "integer",
// "audio": "string",
// "auto_recording": "string",
// "enforce_login": "boolean",
// "enforce_login_domains": "string",
// "alternative_hosts": "string",
// "close_registration": "boolean",
// "show_share_button": "boolean",
// "allow_multiple_devices": "boolean",
// "email_language": "string",
// "panelists_invitation_email_notification": "boolean",
// "registrants_confirmation_email": "boolean",
// "registrants_email_notification": "boolean",
// "attendees_and_panelists_reminder_email_notification": {
// "enable": "boolean",
// "type": "integer"
// },
// "follow_up_attendees_email_notification": {
// "enable": "boolean",
// "type": "integer"
// },
// "follow_up_absentees_email_notification": {
// "enable": "boolean",
// "type": "integer"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "uuid" To sUuid
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "host_id" To sHost_id
Get ComStringOf Of hoJResp "topic" To sTopic
Get ComStringOf Of hoJResp "type" To sV_type
Get ComStringOf Of hoJResp "start_time" To sStart_time
Get ComStringOf Of hoJResp "duration" To sDuration
Get ComStringOf Of hoJResp "timezone" To sTimezone
Get ComStringOf Of hoJResp "agenda" To sAgenda
Get ComStringOf Of hoJResp "created_at" To sCreated_at
Get ComStringOf Of hoJResp "start_url" To sStart_url
Get ComStringOf Of hoJResp "join_url" To sJoin_url
Get ComStringOf Of hoJResp "settings.host_video" To sHost_video
Get ComStringOf Of hoJResp "settings.panelists_video" To sPanelists_video
Get ComStringOf Of hoJResp "settings.practice_session" To sPractice_session
Get ComStringOf Of hoJResp "settings.hd_video" To sHd_video
Get ComStringOf Of hoJResp "settings.hd_video_for_attendees" To sHd_video_for_attendees
Get ComStringOf Of hoJResp "settings.send_1080p_video_to_attendees" To sSend_1080p_video_to_attendees
Get ComStringOf Of hoJResp "settings.approval_type" To sApproval_type
Get ComStringOf Of hoJResp "settings.registration_type" To sRegistration_type
Get ComStringOf Of hoJResp "settings.audio" To sAudio
Get ComStringOf Of hoJResp "settings.auto_recording" To sAuto_recording
Get ComStringOf Of hoJResp "settings.enforce_login" To sEnforce_login
Get ComStringOf Of hoJResp "settings.enforce_login_domains" To sEnforce_login_domains
Get ComStringOf Of hoJResp "settings.alternative_hosts" To sAlternative_hosts
Get ComStringOf Of hoJResp "settings.close_registration" To sClose_registration
Get ComStringOf Of hoJResp "settings.show_share_button" To sShow_share_button
Get ComStringOf Of hoJResp "settings.allow_multiple_devices" To sAllow_multiple_devices
Get ComStringOf Of hoJResp "settings.email_language" To sEmail_language
Get ComStringOf Of hoJResp "settings.panelists_invitation_email_notification" To sPanelists_invitation_email_notification
Get ComStringOf Of hoJResp "settings.registrants_confirmation_email" To sRegistrants_confirmation_email
Get ComStringOf Of hoJResp "settings.registrants_email_notification" To sRegistrants_email_notification
Get ComStringOf Of hoJResp "settings.attendees_and_panelists_reminder_email_notification.enable" To sEnable
Get ComStringOf Of hoJResp "settings.attendees_and_panelists_reminder_email_notification.type" To sV_Type
Get ComStringOf Of hoJResp "settings.follow_up_attendees_email_notification.enable" To sFollow_up_attendees_email_notificationEnable
Get ComStringOf Of hoJResp "settings.follow_up_attendees_email_notification.type" To sFollow_up_attendees_email_notificationType
Get ComStringOf Of hoJResp "settings.follow_up_absentees_email_notification.enable" To sFollow_up_absentees_email_notificationEnable
Get ComStringOf Of hoJResp "settings.follow_up_absentees_email_notification.type" To sFollow_up_absentees_email_notificationType
Move 0 To i
Get ComSizeOfArray Of hoJResp "occurrences" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "occurrences[i].occurrence_id" To sOccurrence_id
Get ComStringOf Of hoJResp "occurrences[i].start_time" To sStart_time
Get ComStringOf Of hoJResp "occurrences[i].duration" To sDuration
Get ComStringOf Of hoJResp "occurrences[i].status" To sStatus
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'topic=tempor esse'
--form 'type=tempor esse5'
--form 'start_time=tempor esse51949-08-06T23:27:19.613Z'
--form 'duration=tempor esse51949-08-06T23:27:19.613Z-79092517'
--form 'timezone=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmod'
--form 'password=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit ut'
--form 'agenda=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco'
--form 'tracking_fields=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]'
--form 'recurrence=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}'
--form 'settings=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}{"host_video":true,"panelists_video":true,"practice_session":false,"hd_video":false,"hd_video_for_attendees":false,"send_1080p_video_to_attendees":false,"approval_type":2,"registration_type":1,"audio":"both","auto_recording":"none","enforce_login":false,"enforce_login_domains":"dolore dolore aute laboris deserunt","alternative_hosts":"pariatur culpa cupidatat quis","close_registration":false,"show_share_button":true,"allow_multiple_devices":false,"on_demand":false,"global_dial_in_countries":["dolor","sit proident in fugiat"],"contact_name":"exercitation","contact_email":"sed ","registrants_restrict_number":0,"post_webinar_survey":false,"survey_url":"sunt ut proident tempor Duis","registrants_email_notification":false,"meeting_authentication":true,"authentication_option":"fugiat irure commodo","authentication_domains":"elit quis","question_and_answer":{"enable":false,"allow_anonymous_questions":false,"answer_questions":"all","attendees_can_upvote":false,"attendees_can_comment":false},"email_language":"adipisicing dolor","panelists_invitation_email_notification":false,"attendees_and_panelists_reminder_email_notification":{"enable":false,"type":7},"follow_up_attendees_email_notification":{"enable":false,"type":2},"follow_up_absentees_email_notification":{"enable":false,"type":3},"language_interpretation":{"enable":true,"interpreters":[{"email":"ObCA8sbYRELjrgF@sNwVXKmVZXJBMYWjGyhnvSqUxHrLGU.vb","languages":"pariatur sed sint"},{"email":"3woHM5Hht5X@Jv.ei","languages":"sunt id sit"}]}}'
--form 'template_id=tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco[{"field":"magna dolor officia","value":"laboris velit dolore qui in"},{"field":"in aliqua do nulla","value":"irure ex labore"}]{"type":2,"repeat_interval":-23462466,"weekly_days":"in adipisicing","monthly_day":-73425465,"monthly_week":3,"monthly_week_day":3,"end_times":1,"end_date_time":"1955-12-31T03:53:07.500Z"}{"host_video":true,"panelists_video":true,"practice_session":false,"hd_video":false,"hd_video_for_attendees":false,"send_1080p_video_to_attendees":false,"approval_type":2,"registration_type":1,"audio":"both","auto_recording":"none","enforce_login":false,"enforce_login_domains":"dolore dolore aute laboris deserunt","alternative_hosts":"pariatur culpa cupidatat quis","close_registration":false,"show_share_button":true,"allow_multiple_devices":false,"on_demand":false,"global_dial_in_countries":["dolor","sit proident in fugiat"],"contact_name":"exercitation","contact_email":"sed ","registrants_restrict_number":0,"post_webinar_survey":false,"survey_url":"sunt ut proident tempor Duis","registrants_email_notification":false,"meeting_authentication":true,"authentication_option":"fugiat irure commodo","authentication_domains":"elit quis","question_and_answer":{"enable":false,"allow_anonymous_questions":false,"answer_questions":"all","attendees_can_upvote":false,"attendees_can_comment":false},"email_language":"adipisicing dolor","panelists_invitation_email_notification":false,"attendees_and_panelists_reminder_email_notification":{"enable":false,"type":7},"follow_up_attendees_email_notification":{"enable":false,"type":2},"follow_up_absentees_email_notification":{"enable":false,"type":3},"language_interpretation":{"enable":true,"interpreters":[{"email":"ObCA8sbYRELjrgF@sNwVXKmVZXJBMYWjGyhnvSqUxHrLGU.vb","languages":"pariatur sed sint"},{"email":"3woHM5Hht5X@Jv.ei","languages":"sunt id sit"}]}}minim ea sunt'
https://api.zoom.us/v2/users/:userId/webinars
Postman Collection Item JSON
{
"name": "Create a webinar",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "topic",
"value": "tempor esse",
"type": "text"
},
{
"key": "type",
"value": "5",
"type": "text"
},
{
"key": "start_time",
"value": "1949-08-06T23:27:19.613Z",
"type": "text"
},
{
"key": "duration",
"value": "-79092517",
"type": "text"
},
{
"key": "timezone",
"value": "dolor fugiat eiusmod",
"type": "text"
},
{
"key": "password",
"value": "eiusmod incididunt nulla mollit ut",
"type": "text"
},
{
"key": "agenda",
"value": "ullamco ",
"type": "text"
},
{
"key": "tracking_fields",
"value": "[{\"field\":\"magna dolor officia\",\"value\":\"laboris velit dolore qui in\"},{\"field\":\"in aliqua do nulla\",\"value\":\"irure ex labore\"}]",
"type": "text"
},
{
"key": "recurrence",
"value": "{\"type\":2,\"repeat_interval\":-23462466,\"weekly_days\":\"in adipisicing\",\"monthly_day\":-73425465,\"monthly_week\":3,\"monthly_week_day\":3,\"end_times\":1,\"end_date_time\":\"1955-12-31T03:53:07.500Z\"}",
"type": "text"
},
{
"key": "settings",
"value": "{\"host_video\":true,\"panelists_video\":true,\"practice_session\":false,\"hd_video\":false,\"hd_video_for_attendees\":false,\"send_1080p_video_to_attendees\":false,\"approval_type\":2,\"registration_type\":1,\"audio\":\"both\",\"auto_recording\":\"none\",\"enforce_login\":false,\"enforce_login_domains\":\"dolore dolore aute laboris deserunt\",\"alternative_hosts\":\"pariatur culpa cupidatat quis\",\"close_registration\":false,\"show_share_button\":true,\"allow_multiple_devices\":false,\"on_demand\":false,\"global_dial_in_countries\":[\"dolor\",\"sit proident in fugiat\"],\"contact_name\":\"exercitation\",\"contact_email\":\"sed \",\"registrants_restrict_number\":0,\"post_webinar_survey\":false,\"survey_url\":\"sunt ut proident tempor Duis\",\"registrants_email_notification\":false,\"meeting_authentication\":true,\"authentication_option\":\"fugiat irure commodo\",\"authentication_domains\":\"elit quis\",\"question_and_answer\":{\"enable\":false,\"allow_anonymous_questions\":false,\"answer_questions\":\"all\",\"attendees_can_upvote\":false,\"attendees_can_comment\":false},\"email_language\":\"adipisicing dolor\",\"panelists_invitation_email_notification\":false,\"attendees_and_panelists_reminder_email_notification\":{\"enable\":false,\"type\":7},\"follow_up_attendees_email_notification\":{\"enable\":false,\"type\":2},\"follow_up_absentees_email_notification\":{\"enable\":false,\"type\":3},\"language_interpretation\":{\"enable\":true,\"interpreters\":[{\"email\":\"ObCA8sbYRELjrgF@sNwVXKmVZXJBMYWjGyhnvSqUxHrLGU.vb\",\"languages\":\"pariatur sed sint\"},{\"email\":\"3woHM5Hht5X@Jv.ei\",\"languages\":\"sunt id sit\"}]}}",
"type": "text"
},
{
"key": "template_id",
"value": "minim ea sunt",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/webinars",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"webinars"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Use this API to schedule a webinar for a user (webinar host). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\nZoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. \n\n**Scopes:** `webinar:write:admin`, `webinar:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n* This API has a daily rate limit of **100 requests per day**. The rate limit is applied to the `userId` of the **webinar host** used to make the request. \n\n**Prerequisites:** \n* A Pro or higher plan with a Webinar add-on."
},
"response": [
{
"name": "**HTTP Status Code:** `201`<br>\nWebinar created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "topic",
"value": "tempor ea exercitation",
"type": "text"
},
{
"key": "type",
"value": "5",
"type": "text"
},
{
"key": "start_time",
"value": "1995-05-05T13:19:45.125Z",
"type": "text"
},
{
"key": "duration",
"value": "5645576",
"type": "text"
},
{
"key": "timezone",
"value": "ea Lorem mollit deserunt",
"type": "text"
},
{
"key": "password",
"value": "dolor in magna velit exercitation",
"type": "text"
},
{
"key": "agenda",
"value": "",
"type": "text"
},
{
"key": "tracking_fields",
"value": "[{\"field\":\"in\",\"value\":\"in incididunt consequat sunt\"},{\"field\":\"pariatur cupidatat amet commodo\",\"value\":\"ullamco mollit deserunt id\"}]",
"type": "text"
},
{
"key": "recurrence",
"value": "{\"type\":3,\"repeat_interval\":-79771761,\"weekly_days\":\"elit dolore qui sint et\",\"monthly_day\":57171772,\"monthly_week\":2,\"monthly_week_day\":1,\"end_times\":1,\"end_date_time\":\"2000-02-21T07:16:51.326Z\"}",
"type": "text"
},
{
"key": "settings",
"value": "{\"host_video\":false,\"panelists_video\":false,\"practice_session\":false,\"hd_video\":false,\"hd_video_for_attendees\":false,\"send_1080p_video_to_attendees\":false,\"approval_type\":2,\"registration_type\":1,\"audio\":\"both\",\"auto_recording\":\"none\",\"enforce_login\":true,\"enforce_login_domains\":\"commodo sunt Lorem\",\"alternative_hosts\":\"culpa aliquip fugiat cillum Excepteur\",\"close_registration\":true,\"show_share_button\":false,\"allow_multiple_devices\":true,\"on_demand\":false,\"global_dial_in_countries\":[\"laborum sunt ex\",\"mollit Excepteur aliquip Duis ea\"],\"contact_name\":\"rep\",\"contact_email\":\"dolor dolor\",\"registrants_restrict_number\":0,\"post_webinar_survey\":false,\"survey_url\":\"cupidatat ut\",\"registrants_email_notification\":false,\"meeting_authentication\":false,\"authentication_option\":\"voluptate eu aliquip pariatur consequat\",\"authentication_domains\":\"D\",\"question_and_answer\":{\"enable\":false,\"allow_anonymous_questions\":true,\"answer_questions\":\"only\",\"attendees_can_upvote\":false,\"attendees_can_comment\":false},\"email_language\":\"laborum ad esse\",\"panelists_invitation_email_notification\":true,\"attendees_and_panelists_reminder_email_notification\":{\"enable\":false,\"type\":2},\"follow_up_attendees_email_notification\":{\"enable\":true,\"type\":3},\"follow_up_absentees_email_notification\":{\"enable\":true,\"type\":2},\"language_interpretation\":{\"enable\":false,\"interpreters\":[{\"email\":\"9skt@wGkeQzGcperFFzWbkmurMaLYays.vvva\",\"languages\":\"ut ex commodo dolore\"},{\"email\":\"gsJ4@orYhfWiNaqGNrESz.vmt\",\"languages\":\"dolore in\"}]}}",
"type": "text"
},
{
"key": "template_id",
"value": "et fugiat labore Lo",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/webinars",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"webinars"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of created Webinar"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"uuid\": \"string\",\n \"id\": \"integer\",\n \"host_id\": \"string\",\n \"topic\": \"string\",\n \"type\": \"integer\",\n \"start_time\": \"string [date-time]\",\n \"duration\": \"integer\",\n \"timezone\": \"string\",\n \"agenda\": \"string\",\n \"created_at\": \"string [date-time]\",\n \"start_url\": \"string\",\n \"join_url\": \"string\",\n \"occurrences\": [\n {\n \"occurrence_id\": \"integer\",\n \"start_time\": \"string [date-time]\",\n \"duration\": \"integer\",\n \"status\": \"string\"\n }\n ],\n \"settings\": {\n \"host_video\": \"boolean\",\n \"panelists_video\": \"boolean\",\n \"practice_session\": \"boolean\",\n \"hd_video\": \"boolean\",\n \"hd_video_for_attendees\": \"boolean\",\n \"send_1080p_video_to_attendees\": \"boolean\",\n \"approval_type\": \"integer\",\n \"registration_type\": \"integer\",\n \"audio\": \"string\",\n \"auto_recording\": \"string\",\n \"enforce_login\": \"boolean\",\n \"enforce_login_domains\": \"string\",\n \"alternative_hosts\": \"string\",\n \"close_registration\": \"boolean\",\n \"show_share_button\": \"boolean\",\n \"allow_multiple_devices\": \"boolean\",\n \"email_language\": \"string\",\n \"panelists_invitation_email_notification\": \"boolean\",\n \"registrants_confirmation_email\": \"boolean\",\n \"registrants_email_notification\": \"boolean\",\n \"attendees_and_panelists_reminder_email_notification\": {\n \"enable\": \"boolean\",\n \"type\": \"integer\"\n },\n \"follow_up_attendees_email_notification\": {\n \"enable\": \"boolean\",\n \"type\": \"integer\"\n },\n \"follow_up_absentees_email_notification\": {\n \"enable\": \"boolean\",\n \"type\": \"integer\"\n }\n }\n}"
},
{
"name": "**HTTP Status Code:** `300`<br>\nA maximum of \"{rateLimitNumber}\" webinars can be created and updated for a single user in one day.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "topic",
"value": "tempor ea exercitation",
"type": "text"
},
{
"key": "type",
"value": "5",
"type": "text"
},
{
"key": "start_time",
"value": "1995-05-05T13:19:45.125Z",
"type": "text"
},
{
"key": "duration",
"value": "5645576",
"type": "text"
},
{
"key": "timezone",
"value": "ea Lorem mollit deserunt",
"type": "text"
},
{
"key": "password",
"value": "dolor in magna velit exercitation",
"type": "text"
},
{
"key": "agenda",
"value": "",
"type": "text"
},
{
"key": "tracking_fields",
"value": "[{\"field\":\"in\",\"value\":\"in incididunt consequat sunt\"},{\"field\":\"pariatur cupidatat amet commodo\",\"value\":\"ullamco mollit deserunt id\"}]",
"type": "text"
},
{
"key": "recurrence",
"value": "{\"type\":3,\"repeat_interval\":-79771761,\"weekly_days\":\"elit dolore qui sint et\",\"monthly_day\":57171772,\"monthly_week\":2,\"monthly_week_day\":1,\"end_times\":1,\"end_date_time\":\"2000-02-21T07:16:51.326Z\"}",
"type": "text"
},
{
"key": "settings",
"value": "{\"host_video\":false,\"panelists_video\":false,\"practice_session\":false,\"hd_video\":false,\"hd_video_for_attendees\":false,\"send_1080p_video_to_attendees\":false,\"approval_type\":2,\"registration_type\":1,\"audio\":\"both\",\"auto_recording\":\"none\",\"enforce_login\":true,\"enforce_login_domains\":\"commodo sunt Lorem\",\"alternative_hosts\":\"culpa aliquip fugiat cillum Excepteur\",\"close_registration\":true,\"show_share_button\":false,\"allow_multiple_devices\":true,\"on_demand\":false,\"global_dial_in_countries\":[\"laborum sunt ex\",\"mollit Excepteur aliquip Duis ea\"],\"contact_name\":\"rep\",\"contact_email\":\"dolor dolor\",\"registrants_restrict_number\":0,\"post_webinar_survey\":false,\"survey_url\":\"cupidatat ut\",\"registrants_email_notification\":false,\"meeting_authentication\":false,\"authentication_option\":\"voluptate eu aliquip pariatur consequat\",\"authentication_domains\":\"D\",\"question_and_answer\":{\"enable\":false,\"allow_anonymous_questions\":true,\"answer_questions\":\"only\",\"attendees_can_upvote\":false,\"attendees_can_comment\":false},\"email_language\":\"laborum ad esse\",\"panelists_invitation_email_notification\":true,\"attendees_and_panelists_reminder_email_notification\":{\"enable\":false,\"type\":2},\"follow_up_attendees_email_notification\":{\"enable\":true,\"type\":3},\"follow_up_absentees_email_notification\":{\"enable\":true,\"type\":2},\"language_interpretation\":{\"enable\":false,\"interpreters\":[{\"email\":\"9skt@wGkeQzGcperFFzWbkmurMaLYays.vvva\",\"languages\":\"ut ex commodo dolore\"},{\"email\":\"gsJ4@orYhfWiNaqGNrESz.vmt\",\"languages\":\"dolore in\"}]}}",
"type": "text"
},
{
"key": "template_id",
"value": "et fugiat labore Lo",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/webinars",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"webinars"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`\nSubscription plan for webinar is missing. Enable webinar for this user once the subscription plan is added:{userId}.<br>\n* Users in '{0}' have been blocked from joining meetings and web",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "topic",
"value": "tempor ea exercitation",
"type": "text"
},
{
"key": "type",
"value": "5",
"type": "text"
},
{
"key": "start_time",
"value": "1995-05-05T13:19:45.125Z",
"type": "text"
},
{
"key": "duration",
"value": "5645576",
"type": "text"
},
{
"key": "timezone",
"value": "ea Lorem mollit deserunt",
"type": "text"
},
{
"key": "password",
"value": "dolor in magna velit exercitation",
"type": "text"
},
{
"key": "agenda",
"value": "",
"type": "text"
},
{
"key": "tracking_fields",
"value": "[{\"field\":\"in\",\"value\":\"in incididunt consequat sunt\"},{\"field\":\"pariatur cupidatat amet commodo\",\"value\":\"ullamco mollit deserunt id\"}]",
"type": "text"
},
{
"key": "recurrence",
"value": "{\"type\":3,\"repeat_interval\":-79771761,\"weekly_days\":\"elit dolore qui sint et\",\"monthly_day\":57171772,\"monthly_week\":2,\"monthly_week_day\":1,\"end_times\":1,\"end_date_time\":\"2000-02-21T07:16:51.326Z\"}",
"type": "text"
},
{
"key": "settings",
"value": "{\"host_video\":false,\"panelists_video\":false,\"practice_session\":false,\"hd_video\":false,\"hd_video_for_attendees\":false,\"send_1080p_video_to_attendees\":false,\"approval_type\":2,\"registration_type\":1,\"audio\":\"both\",\"auto_recording\":\"none\",\"enforce_login\":true,\"enforce_login_domains\":\"commodo sunt Lorem\",\"alternative_hosts\":\"culpa aliquip fugiat cillum Excepteur\",\"close_registration\":true,\"show_share_button\":false,\"allow_multiple_devices\":true,\"on_demand\":false,\"global_dial_in_countries\":[\"laborum sunt ex\",\"mollit Excepteur aliquip Duis ea\"],\"contact_name\":\"rep\",\"contact_email\":\"dolor dolor\",\"registrants_restrict_number\":0,\"post_webinar_survey\":false,\"survey_url\":\"cupidatat ut\",\"registrants_email_notification\":false,\"meeting_authentication\":false,\"authentication_option\":\"voluptate eu aliquip pariatur consequat\",\"authentication_domains\":\"D\",\"question_and_answer\":{\"enable\":false,\"allow_anonymous_questions\":true,\"answer_questions\":\"only\",\"attendees_can_upvote\":false,\"attendees_can_comment\":false},\"email_language\":\"laborum ad esse\",\"panelists_invitation_email_notification\":true,\"attendees_and_panelists_reminder_email_notification\":{\"enable\":false,\"type\":2},\"follow_up_attendees_email_notification\":{\"enable\":true,\"type\":3},\"follow_up_absentees_email_notification\":{\"enable\":true,\"type\":2},\"language_interpretation\":{\"enable\":false,\"interpreters\":[{\"email\":\"9skt@wGkeQzGcperFFzWbkmurMaLYays.vvva\",\"languages\":\"ut ex commodo dolore\"},{\"email\":\"gsJ4@orYhfWiNaqGNrESz.vmt\",\"languages\":\"dolore in\"}]}}",
"type": "text"
},
{
"key": "template_id",
"value": "et fugiat labore Lo",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/webinars",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"webinars"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br><br>\n**Error Code:** `1001`<br>\nUser {userId} not exist or not belong to this account.\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "topic",
"value": "tempor ea exercitation",
"type": "text"
},
{
"key": "type",
"value": "5",
"type": "text"
},
{
"key": "start_time",
"value": "1995-05-05T13:19:45.125Z",
"type": "text"
},
{
"key": "duration",
"value": "5645576",
"type": "text"
},
{
"key": "timezone",
"value": "ea Lorem mollit deserunt",
"type": "text"
},
{
"key": "password",
"value": "dolor in magna velit exercitation",
"type": "text"
},
{
"key": "agenda",
"value": "",
"type": "text"
},
{
"key": "tracking_fields",
"value": "[{\"field\":\"in\",\"value\":\"in incididunt consequat sunt\"},{\"field\":\"pariatur cupidatat amet commodo\",\"value\":\"ullamco mollit deserunt id\"}]",
"type": "text"
},
{
"key": "recurrence",
"value": "{\"type\":3,\"repeat_interval\":-79771761,\"weekly_days\":\"elit dolore qui sint et\",\"monthly_day\":57171772,\"monthly_week\":2,\"monthly_week_day\":1,\"end_times\":1,\"end_date_time\":\"2000-02-21T07:16:51.326Z\"}",
"type": "text"
},
{
"key": "settings",
"value": "{\"host_video\":false,\"panelists_video\":false,\"practice_session\":false,\"hd_video\":false,\"hd_video_for_attendees\":false,\"send_1080p_video_to_attendees\":false,\"approval_type\":2,\"registration_type\":1,\"audio\":\"both\",\"auto_recording\":\"none\",\"enforce_login\":true,\"enforce_login_domains\":\"commodo sunt Lorem\",\"alternative_hosts\":\"culpa aliquip fugiat cillum Excepteur\",\"close_registration\":true,\"show_share_button\":false,\"allow_multiple_devices\":true,\"on_demand\":false,\"global_dial_in_countries\":[\"laborum sunt ex\",\"mollit Excepteur aliquip Duis ea\"],\"contact_name\":\"rep\",\"contact_email\":\"dolor dolor\",\"registrants_restrict_number\":0,\"post_webinar_survey\":false,\"survey_url\":\"cupidatat ut\",\"registrants_email_notification\":false,\"meeting_authentication\":false,\"authentication_option\":\"voluptate eu aliquip pariatur consequat\",\"authentication_domains\":\"D\",\"question_and_answer\":{\"enable\":false,\"allow_anonymous_questions\":true,\"answer_questions\":\"only\",\"attendees_can_upvote\":false,\"attendees_can_comment\":false},\"email_language\":\"laborum ad esse\",\"panelists_invitation_email_notification\":true,\"attendees_and_panelists_reminder_email_notification\":{\"enable\":false,\"type\":2},\"follow_up_attendees_email_notification\":{\"enable\":true,\"type\":3},\"follow_up_absentees_email_notification\":{\"enable\":true,\"type\":2},\"language_interpretation\":{\"enable\":false,\"interpreters\":[{\"email\":\"9skt@wGkeQzGcperFFzWbkmurMaLYays.vvva\",\"languages\":\"ut ex commodo dolore\"},{\"email\":\"gsJ4@orYhfWiNaqGNrESz.vmt\",\"languages\":\"dolore in\"}]}}",
"type": "text"
},
{
"key": "template_id",
"value": "et fugiat labore Lo",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId/webinars",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"webinars"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
