MeetingCreateSettings.md

# MeetingCreateSettings

Properties

Name	Type	Description	Notes
additional_data_center_regions	string[]	Add additional meeting data center regions. Provide this value as an array of country codes for the countries available as data center regions in the Account Profile interface but have been opted out of in the user settings. For example, the data center regions selected in your Account Profile are "Europe", "Hong Kong SAR", "Australia", "India", "Japan", "China", "United States", and "Canada". However, in the My Profile settings, you did not select "India" and "Japan" for meeting and webinar traffic routing. To include "India" and "Japan" as additional data centers, use the `["IN", "TY"]` value for this field.	[optional]
allow_multiple_devices	bool	Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled.	[optional]
alternative_hosts	string	A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs.	[optional]
alternative_hosts_email_notification	bool	Whether to send email notifications to alternative hosts. This value defaults to `true`.	[optional] [default to true]
approval_type	int	Enable meeting registration approval: * `0` — Automatically approve registration. * `1` — Manually approve registration. * `2` — No registration required. This value defaults to `2`.	[optional] [default to self::APPROVAL_TYPE_2]
approved_or_denied_countries_or_regions	\Zoom\Api\Model\MeetingCreateSettingsApprovedOrDeniedCountriesOrRegions		[optional]
audio	string	How participants join the audio portion of the meeting: * `both` — Both telephony and VoIP. * `telephony` — Telephony only. * `voip` — VoIP only. This value defaults to `both`.	[optional] [default to 'both']
authentication_domains	string	The meeting's authenticated domains. Only Zoom users whose email address contains an authenticated domain can join the meeting. Comma-separate multiple domains or use a wildcard for listing domains.	[optional]
authentication_exception	\Zoom\Api\Model\MeetingCreateSettingsAuthenticationExceptionInner[]	A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite.	[optional]
authentication_option	string	If the `meeting_authentication` value is `true`, the type of authentication required for users to join a meeting. To get this value, use the `authentication_options` array's `id` value in the Get user settings API response.	[optional]
auto_recording	string	The automatic recording settings: * `local` — Record the meeting locally. * `cloud` — Record the meeting to the cloud. * `none` — Auto-recording disabled. This value defaults to `none`.	[optional] [default to 'none']
breakout_room	\Zoom\Api\Model\MeetingCreateSettingsBreakoutRoom		[optional]
calendar_type	int	Indicates the type of calendar integration used to schedule the meeting: * `1` — Zoom Outlook add-in * `2` — Zoom for Google Workspace add-on Works with the `private_meeting` field to determine whether to share details of meetings or not.	[optional]
close_registration	bool	Whether to close registration after the event date. This value defaults to `false`.	[optional] [default to false]
cn_meeting	bool	Whether to host the meeting in China (CN). This value defaults to `false`.	[optional] [default to false]
contact_email	string	The contact email address for meeting registration.	[optional]
contact_name	string	The contact name for meeting registration.	[optional]
email_notification	bool	Whether to send email notifications to alternative hosts and users with scheduling privileges. This value defaults to `true`.	[optional] [default to true]
encryption_type	string	The type of end-to-end (E2EE) encryption to use for the meeting: * `enhanced_encryption` — Enhanced encryption. Encryption is stored in the cloud when you enable this option. * `e2ee` — End-to-end encryption. The encryption key is stored on your local device and cannot be obtained by anyone else. When you use E2EE encryption, certain features, such as cloud recording or phone and SIP/H.323 dial-in, are disabled.	[optional]
focus_mode	bool	Whether to enable the Focus Mode feature when the meeting starts.	[optional]
global_dial_in_countries	string[]	A list of available global dial-in countries.	[optional]
host_video	bool	Whether to start meetings with the host video on.	[optional]
in_meeting	bool	Whether to host the meeting in India (IN). This value defaults to `false`.	[optional] [default to false]
jbh_time	int	If the value of the `join_before_host` field is `true`, this field indicates the time limits within which a participant can join a meeting before the meeting's host: * `0` — Allow the participant to join the meeting at anytime. * `5` — Allow the participant to join 5 minutes before the meeting's start time. * `10` — Allow the participant to join 10 minutes before the meeting's start time.	[optional]
join_before_host	bool	Whether participants can join the meeting before its host. This field is only used for scheduled meetings (`2`) or recurring meetings (`3` and `8`). This value defaults to `false`. If the Waiting Room feature is enabled, this setting is disabled.	[optional] [default to false]
language_interpretation	\Zoom\Api\Model\MeetingCreateSettingsLanguageInterpretation		[optional]
meeting_authentication	bool	If true, only authenticated users can join the meeting.	[optional]
meeting_invitees	\Zoom\Api\Model\MeetingCreateSettingsMeetingInviteesInner[]	A list of the meeting's invitees.	[optional]
mute_upon_entry	bool	Whether to mute participants upon entry.	[optional] [default to false]
participant_video	bool	Whether to start meetings with the participant video on.	[optional]
private_meeting	bool	Whether to set the meeting as private.	[optional]
registrants_confirmation_email	bool	Whether to send registrants an email confirmation: * `true` — Send a confirmation email. * `false` — Do not send a confirmation email.	[optional]
registrants_email_notification	bool	Whether to send registrants email notifications about their registration approval, cancellation, or rejection: * `true` — Send an email notification. * `false` — Do not send an email notification. Set this value to `true` to also use the `registrants_confirmation_email` parameter.	[optional]
registration_type	int	The meeting's registration type: * `1` — Attendees register once and can attend any meeting occurrence. * `2` — Attendees must register for each meeting occurrence. * `3` — Attendees register once and can select one or more meeting occurrences to attend. This field is only for recurring meetings with fixed times (`8`). This value defaults to `1`.	[optional] [default to self::REGISTRATION_TYPE_1]
show_share_button	bool	Whether to include social media sharing buttons on the meeting's registration page. This setting is only applied to meetings with registration enabled.	[optional]
use_pmi	bool	Whether to use a Personal Meeting ID (PMI) instead of a generated meeting ID. This field is only used for scheduled meetings (`2`), instant meetings (`1`), or recurring meetings with no fixed time (`3`). This value defaults to `false`.	[optional] [default to false]
waiting_room	bool	Whether to enable the Waiting Room feature. If this value is `true`, this disables the `join_before_host` setting.	[optional]
watermark	bool	Whether to add a watermark when viewing a shared screen.	[optional] [default to false]
host_save_video_order	bool	Whether the Allow host to save video order feature is enabled.	[optional]
alternative_host_update_polls	bool	Whether the Allow alternative hosts to add or edit polls feature is enabled. This requires Zoom version 5.8.0 or higher.	[optional]

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