delphiDll / Zoom API / Create a webinar
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
occurrence_id: PWideChar;
status: PWideChar;
uuid: PWideChar;
id: PWideChar;
host_id: PWideChar;
topic: PWideChar;
v_type: PWideChar;
start_time: PWideChar;
duration: PWideChar;
timezone: PWideChar;
agenda: PWideChar;
created_at: PWideChar;
start_url: PWideChar;
join_url: PWideChar;
Host_video: PWideChar;
Panelists_video: PWideChar;
Practice_session: PWideChar;
Hd_video: PWideChar;
Hd_video_for_attendees: PWideChar;
Send_1080p_video_to_attendees: PWideChar;
Approval_type: PWideChar;
Registration_type: PWideChar;
Audio: PWideChar;
Auto_recording: PWideChar;
Enforce_login: PWideChar;
Enforce_login_domains: PWideChar;
Alternative_hosts: PWideChar;
Close_registration: PWideChar;
Show_share_button: PWideChar;
Allow_multiple_devices: PWideChar;
Email_language: PWideChar;
Panelists_invitation_email_notification: PWideChar;
Registrants_confirmation_email: PWideChar;
Registrants_email_notification: PWideChar;
Enable: PWideChar;
v_Type: PWideChar;
Follow_up_attendees_email_notificationEnable: PWideChar;
Follow_up_attendees_email_notificationType: PWideChar;
Follow_up_absentees_email_notificationEnable: PWideChar;
Follow_up_absentees_email_notificationType: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/v2/users/:userId/webinars');
CkHttpRequest_putContentType(req,'multipart/form-data');
CkHttpRequest_AddParam(req,'topic','tempor esse');
CkHttpRequest_AddParam(req,'','');
CkHttpRequest_AddParam(req,'start_time','tempor esse51949-08-06T23:27:19.613Z');
CkHttpRequest_AddParam(req,'duration','tempor esse51949-08-06T23:27:19.613Z-79092517');
CkHttpRequest_AddParam(req,'timezone','tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmod');
CkHttpRequest_AddParam(req,'password','tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit ut');
CkHttpRequest_AddParam(req,'agenda','tempor esse51949-08-06T23:27:19.613Z-79092517dolor fugiat eiusmodeiusmod incididunt nulla mollit utullamco');
CkHttpRequest_AddParam(req,'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"}]');
CkHttpRequest_AddParam(req,'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"}');
CkHttpRequest_AddParam(req,'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"}]}}');
CkHttpRequest_AddParam(req,'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');
CkHttpRequest_AddHeader(req,'Authorization','Bearer <access_token>');
resp := CkHttp_SynchronousRequest(http,'api.zoom.us',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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
uuid := CkJsonObject__stringOf(jResp,'uuid');
id := CkJsonObject__stringOf(jResp,'id');
host_id := CkJsonObject__stringOf(jResp,'host_id');
topic := CkJsonObject__stringOf(jResp,'topic');
v_type := CkJsonObject__stringOf(jResp,'type');
start_time := CkJsonObject__stringOf(jResp,'start_time');
duration := CkJsonObject__stringOf(jResp,'duration');
timezone := CkJsonObject__stringOf(jResp,'timezone');
agenda := CkJsonObject__stringOf(jResp,'agenda');
created_at := CkJsonObject__stringOf(jResp,'created_at');
start_url := CkJsonObject__stringOf(jResp,'start_url');
join_url := CkJsonObject__stringOf(jResp,'join_url');
Host_video := CkJsonObject__stringOf(jResp,'settings.host_video');
Panelists_video := CkJsonObject__stringOf(jResp,'settings.panelists_video');
Practice_session := CkJsonObject__stringOf(jResp,'settings.practice_session');
Hd_video := CkJsonObject__stringOf(jResp,'settings.hd_video');
Hd_video_for_attendees := CkJsonObject__stringOf(jResp,'settings.hd_video_for_attendees');
Send_1080p_video_to_attendees := CkJsonObject__stringOf(jResp,'settings.send_1080p_video_to_attendees');
Approval_type := CkJsonObject__stringOf(jResp,'settings.approval_type');
Registration_type := CkJsonObject__stringOf(jResp,'settings.registration_type');
Audio := CkJsonObject__stringOf(jResp,'settings.audio');
Auto_recording := CkJsonObject__stringOf(jResp,'settings.auto_recording');
Enforce_login := CkJsonObject__stringOf(jResp,'settings.enforce_login');
Enforce_login_domains := CkJsonObject__stringOf(jResp,'settings.enforce_login_domains');
Alternative_hosts := CkJsonObject__stringOf(jResp,'settings.alternative_hosts');
Close_registration := CkJsonObject__stringOf(jResp,'settings.close_registration');
Show_share_button := CkJsonObject__stringOf(jResp,'settings.show_share_button');
Allow_multiple_devices := CkJsonObject__stringOf(jResp,'settings.allow_multiple_devices');
Email_language := CkJsonObject__stringOf(jResp,'settings.email_language');
Panelists_invitation_email_notification := CkJsonObject__stringOf(jResp,'settings.panelists_invitation_email_notification');
Registrants_confirmation_email := CkJsonObject__stringOf(jResp,'settings.registrants_confirmation_email');
Registrants_email_notification := CkJsonObject__stringOf(jResp,'settings.registrants_email_notification');
Enable := CkJsonObject__stringOf(jResp,'settings.attendees_and_panelists_reminder_email_notification.enable');
v_Type := CkJsonObject__stringOf(jResp,'settings.attendees_and_panelists_reminder_email_notification.type');
Follow_up_attendees_email_notificationEnable := CkJsonObject__stringOf(jResp,'settings.follow_up_attendees_email_notification.enable');
Follow_up_attendees_email_notificationType := CkJsonObject__stringOf(jResp,'settings.follow_up_attendees_email_notification.type');
Follow_up_absentees_email_notificationEnable := CkJsonObject__stringOf(jResp,'settings.follow_up_absentees_email_notification.enable');
Follow_up_absentees_email_notificationType := CkJsonObject__stringOf(jResp,'settings.follow_up_absentees_email_notification.type');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'occurrences');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
occurrence_id := CkJsonObject__stringOf(jResp,'occurrences[i].occurrence_id');
start_time := CkJsonObject__stringOf(jResp,'occurrences[i].start_time');
duration := CkJsonObject__stringOf(jResp,'occurrences[i].duration');
status := CkJsonObject__stringOf(jResp,'occurrences[i].status');
i := i + 1;
end;
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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": ""
}
]
}
