postUsersByUserIdWebinars |
Create a webinarCreate a webinar for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside>
Catalog: Zoom
Schema: Webinars
This is a read-only table function. The Zoom API may not support changing the data or the Invantive SQL driver for Zoom does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Zoom API.
Select Zoom API URL: /users/{userId}/webinars
Insert Zoom API URL: /users/{userId}/webinars
Update Zoom API URL: /users/{userId}/webinars
Delete Zoom API URL: /users/{userId}/webinars
Field Selection Method: NotRequired
Select Zoom API Operation: post /users/{userId}/webinars
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function postUsersByUserIdWebinars. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
body |
string |
☑ |
|
User |
userId |
string |
☑ |
|
The user ID or email address |
Table Function Columns
The columns of the table function postUsersByUserIdWebinars are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
agenda |
string |
|
☐ |
Webinar agenda |
created_at |
datetime |
|
☐ |
Create time |
duration |
int64 |
|
☐ |
Webinar duration |
host_id |
string |
|
☐ |
ID of the user set as host of Webinar |
id |
string |
|
☐ |
Webinar ID, also known as Webinar number |
join_url |
string |
|
☐ |
Join url |
RESULT |
string |
|
☐ |
Outcome of operation as single plain text column. |
settings_allow_multiple_devices |
boolean |
|
☐ |
Allow attendees to join from multiple devices |
settings_alternative_hosts |
string |
|
☐ |
Alternative hosts emails or IDs. Multiple values separated by comma. |
settings_approval_type |
int64 |
|
☐ |
|
settings_audio |
string |
|
☐ |
Determine how participants can join the audio portion of the meeting |
settings_auto_recording |
string |
|
☐ |
|
settings_close_registration |
boolean |
|
☐ |
Close registration after event date |
settings_enforce_login_domains |
string |
|
☐ |
Only signed-in users with specified domains can join meetings |
settings_enforce_login |
boolean |
|
☐ |
Only signed-in users can join this meeting |
settings_hd_video |
boolean |
|
☐ |
Default to HD Video |
settings_host_video |
boolean |
|
☐ |
Start video when host joins webinar |
settings_on_demand |
boolean |
|
☐ |
Make the webinar on-demand |
settings_panelists_video |
boolean |
|
☐ |
Start video when panelists join webinar |
settings_practice_session |
boolean |
|
☐ |
Enable Practice Session |
settings_registration_type |
int64 |
|
☐ |
Registration type. Used for recurring webinar with fixed time only. |
settings_show_share_button |
boolean |
|
☐ |
Show social share buttons on registration page |
start_time |
datetime |
|
☐ |
Webinar start time |
start_url |
string |
|
☐ |
Start url |
timezone |
string |
|
☐ |
Timezone to format start_time |
topic |
string |
|
☐ |
Webinar topic |
type |
int64 |
|
☐ |
Webinar Type |
uuid |
string |
|
☐ |
Webinar unique ID |
16-06-2022 17:21 Version 22.1.46-BETA+3385