Skip to content

Latest commit

 

History

History
28 lines (25 loc) · 4.86 KB

WebinarCreate201Response.md

File metadata and controls

28 lines (25 loc) · 4.86 KB

# WebinarCreate201Response

Properties

Name Type Description Notes
host_email string Email address of the meeting host. [optional]
host_id string ID of the user set as host of the webinar. [optional]
id int Webinar ID in "long" format(represented as int64 data type in JSON), also known as the webinar number. [optional]
registrants_confirmation_email bool Specify whether or not registrants of this Webinar should receive confirmation emails. [optional]
template_id string Unique identifier of the Webinar template. Use this field only if you would like to schedule the webinar using an existing template. The value of this field can be retrieved from List webinar templates API. You must provide the user ID of the host instead of the email address in the `userId` path parameter in order to use a template for scheduling a Webinar. [optional]
uuid string Unique identifier of a Webinar. Each Webinar instance will generate its own UUID(i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Once a Webinar ends, the value of uuid for the same webinar will be different from when it was scheduled. [optional]
agenda string Webinar agenda. [optional]
created_at \DateTime Create time. [optional]
duration int Webinar duration. [optional]
join_url string URL to join the Webinar. This URL should only be shared with the users who should be invited to the Webinar. [optional]
occurrences \Zoom\Api\Model\Occurrence[] Array of occurrence objects. [optional]
password string Webinar passcode. If &quot;Require a passcode when scheduling new meetings&quot; setting has been enabled and locked for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request. <br><br> Note: If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements. <br><br>If the requirements are enabled, you can view those requirements by calling either the Get user settings API or the Get account settings API. [optional]
recurrence \Zoom\Api\Model\RecurrenceWebinar [optional]
settings \Zoom\Api\Model\WebinarSettings [optional]
start_time \DateTime Webinar start time in GMT/UTC. [optional]
start_url string <br><aside>The <code>start_url</code> of a Webinar is a URL using which a host or an alternative host can start the Webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the Webinar. The expiration time for the <code>start_url</code> field listed in the response of the Create a webinar API is two hours for all regular users. For users created using the <code>custCreate</code> option via the Create users API, the expiration time of the <code>start_url</code> field is 90 days. For security reasons, to retrieve the latest value for the <code>start_url</code> field programmatically (after expiry), you must call the Get a webinar API and refer to the value of the <code>start_url</code> field in the response.</aside><br><br><br> [optional]
timezone string Time zone to format start_time. [optional]
topic string Webinar topic. [optional]
tracking_fields \Zoom\Api\Model\SessionUpdateTrackingFieldsInner[] Tracking fields [optional]
type int Webinar Types:<br>`5` - Webinar.<br>`6` - Recurring webinar with no fixed time.<br>`9` - Recurring webinar with a fixed time. [optional] [default to self::TYPE_5]

[Back to Model list] [Back to API list] [Back to README]