Select Friend
Zoom
Resource Type
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| schedule_meeting | object | Meeting scheduling settings. | |
| use_pmi_for_scheduled_meetings | boolean | Use the Personal Meeting ID (PMI) when scheduling a meeting. | |
| personal_meeting | boolean | Whether Personal Meeting IDs are enabled or not. If true, users receive a unique dedicated 9-11 digit number which can be used as the user's personal meeting room. | |
| participant_video | boolean | Start meetings with the participant video on. | |
| require_password_for_instant_meetings | boolean | Require a password for instant meetings. | |
| enforce_login | boolean | Only Zoom users who are signed in can join meetings. | |
| require_password_for_pmi_meetings | string | Require a password for a meeting held using a Personal Meeting ID (PMI). | |
| require_password_for_scheduling_new_meetings | boolean | Require a password when scheduling new meetings. | |
| use_pmi_for_instant_meetings | boolean | Use the Personal Meeting ID (PMI) when starting an instant meeting. | |
| join_before_host | boolean | Allow participants to join the meeting before the host arrives. | |
| not_store_meeting_topic | boolean | Always display "Zoom Meeting" as the meeting topic. | |
| host_video | boolean | Start meetings with the host video on. | |
| in_meeting | object | In-meeting settings. | |
| record_play_own_voice | boolean | When someone joins by phone, ask them to record their own voice to use as a notification when they join. | |
| who_can_share_screen_when_someone_is_sharing | string | Indicates who is allowed to start sharing their screen when someone else in the meeting is sharing their screen. | |
| co_host | boolean | Allow the host to add co-hosts. | |
| auto_saving_chat | boolean | Automatically save all in-meeting chats so that the host does not need to manually save the chat transcript after the meeting starts. | |
| remote_control | boolean | When screen sharing, the person who is sharing can allow others to control the shared content. | |
| who_can_share_screen | string | Indicates who can share their screen or content during meetings. | |
| p2p_connetion | boolean | Allow users to directly connect to one another in a 2-person meeting. | |
| feedback | boolean | Add a \"Feedback\" tab to the Windows Settings or Mac Preferences dialog. This enables users to provide feedback to Zoom at the end of the meeting. | |
| private_chat | boolean | Allow a meeting participant to send a private message to another participant. | |
| e2e_encryption | boolean | By default, Zoom requires encryption for all data between the Zoom cloud, Zoom client, and Zoom Room. If this setting is set to `true`, encryption will also be enabled for third-party endpoints (SIP/H.323) as well. | |
| polling | boolean | Allow hosts to add polls/quizzes before or during a meeting | |
| annotation | boolean | Allow participants to use annotation tools to add information while sharing their screen. | |
| sending_default_email_invites | boolean | Allow users to invite participants by email only by using the default email program selected on their computer. | |
| request_permission_to_unmute_participants | boolean | Indicates whether the "Request permission to unmute participants" option has been enabled for the account or not. | |
| breakout_room | boolean | Allow the host to split meeting participants into separate, smaller rooms. | |
| virtual_background | boolean | Allow users to replace their background with any selected image. | |
| manual_captioning | object | Information about manual captioning settings. | |
| manual_captions | boolean | Whether to enable manual closed captioning. | |
| allow_to_type | boolean | Whether to allow the host to manually caption. | |
| auto_generated_captions | boolean | Whether to enable Zoom's live transcription feature. | |
| full_transcript | boolean | Whether to enable the viewing of full transcripts in the in-meeting side panel. | |
| save_captions | boolean | Whether to allow participants to save closed captions or transcripts. | |
| allow_show_zoom_windows | boolean | Show the Zoom desktop application when sharing screens. | |
| chat | boolean | Allow meeting participants to send a message that is visible to all participants. | |
| file_transfer | boolean | Indicates whether the in-meeting file transfer setting has been enabled on the account or not. | |
| show_meeting_control_toolbar | boolean | Always show the meeting controls during a meeting. | |
| allow_live_streaming | boolean | Allow live streaming of meetings. | |
| auto_answer | boolean | Enable users to see and add contacts to the \"auto-answer group\" in the chat contact list. Any call from members of this group will automatically be answered. | |
| meeting_reactions | boolean | Enable or disable meeting reactions. | |
| closed_caption | boolean | Allow a host to type closed captions. Enable a host to assign a participant or use a third party device to add closed captions. | |
| alert_guest_join | boolean | Identify guest participants in a meeting or webinar. | |
| watermark | boolean | Add a watermark when viewing a shared screen. | |
| allow_participants_to_rename | boolean | If the value of this field is set to `true`, meeting participants and webinar panelists are allowed to rename themselves during a meeting or a webinar. | |
| screen_sharing | boolean | Allow the host and participants to share their screen or content during meetings. | |
| use_html_format_email | boolean | Use HTML formatted email for the Outlook plugin. | |
| virtual_background_settings | object | Settings to manage virtual background. | |
| allow_videos | boolean | Allow use of videos for virtual backgrounds. | |
| allow_upload_custom | boolean | Allow users to upload custom backgrounds. | |
| whiteboard | boolean | Allow participants to share a whiteboard that includes annotation tools. | |
| far_end_camera_control | boolean | Allow another user to take control of your camera during a meeting. | |
| show_a_join_from_your_browser_link | boolean | Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited. | |
| email_notification | object | Account Settings - Email Notifications. | |
| cancel_meeting_reminder | boolean | Notify the host and participants when a meeting is cancelled. | |
| jbh_reminder | boolean | Notify the host when participants join the meeting before them. | |
| alternative_host_reminder | boolean | Notify the host when an alternative host is set or removed from a meeting. | |
| schedule_for_reminder | boolean | Notify the host when there is a meeting that is scheduled, rescheduled, or cancelled. | |
| cloud_recording_available_reminder | boolean | Notify the host when a cloud recording of a meeting is available. | |
| recording | object | Account Settings - Recording. | |
| save_chat_text | boolean | Save the chat text from the meeting. | |
| local_recording | boolean | Allow hosts and participants to record the meeting to a local file. | |
| cloud_recording | boolean | Allow hosts to record and save the meeting in the cloud. | |
| show_timestamp | boolean | Add a timestamp to the recording. | |
| prevent_host_access_recording | boolean | If the value of this field is set to `true`, meeting hosts cannot view their meetings' cloud recordings. | |
| record_gallery_view | boolean | Record the gallery view with a shared screen. | |
| auto_recording | string | Automatic recording. local - Record on local. cloud - Record on cloud. none - Disabled. | |
| host_delete_cloud_recording | boolean | If the value of this field is set to `true`, hosts will be able to delete the recordings. If this option is set to `false`, the recordings cannot be deleted by the host, and only the admin can delete them. | |
| record_audio_file | boolean | Record an only audio file for all participants. | |
| cloud_recording_download | boolean | Downloading cloud recordings is enabled. | |
| cloud_recording_download_host | boolean | Only the host can download cloud recordings. | |
| allow_recovery_deleted_cloud_recordings | boolean | Allow the recovery of deleted cloud recordings from trash. If the value of this field is set to `true`, deleted cloud recordings will be kept in trash for 30 days after deletion and can be recovered within that period. | |
| required_password_for_shared_cloud_recordings | boolean | Require a passcode to access shared cloud recordings. This setting is applicable for newly generated recordings only. | |
| record_speaker_view | boolean | Record the active speaker with a shared screen. | |
| recording_disclaimer | boolean | Show a disclaimer to participants before a recording starts. | |
| tsp | object | Account Settings - TSP. | |
| show_international_numbers_link | boolean | Show the link to international numbers on the invitation email. | |
| display_toll_free_numbers | boolean | Display toll-free numbers. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| meeting_security | object | Meeting Security Settings | |
| waiting_room_settings | object | Specify the settings to be applied if the Waiting Room feature is enabled. | |
| participants_to_place_in_waiting_room | number | Specify who should be admitted to the waiting room. The value of this field can be one of the following: 0: All attendees. 1: Users who are not in your account. 2: Users who are not in your account and are not part of the specified whitelisted domains. | |
| waiting_room | boolean | When participants join a meeting, place them in a waiting room and require the host to admit them individually. | |
| embed_password_in_join_link | boolean | If set to `true`, the meeting passcode will be encrypted and included in the invite link to allow participants to join with just one click without having to enter the passcode. | |
| phone_password | boolean | Require a passcode for participants joining by phone. | |
| meeting_password_requirement | object | Meeting password requirements | |
| have_letter | boolean | If set to `true`, the password must contain at least 1 letter. | |
| have_number | boolean | If set to `true`, the password must contain at least 1 number. | |
| have_special_character | boolean | If set to `true`, the password must have at least 1 special character (!, @, #, etc.). | |
| only_allow_numeric | boolean | If set to `true`, the password must only contain numbers and no other characters. | |
| have_upper_and_lower_characters | boolean | If set to `true`, the password must include both uppercase and lowercase characters. | |
| consecutive_characters_length | number | Number of consecutive identical characters allowed in a password. | |
| weak_enhance_detection | boolean | If set to `true`, users will be informed if the provided password is weak. | |
| length | number | The minimum length that the meeting/webinar password needs to have. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| user_modifiable_info_by_admin | list<string> | List of user attributes that can only be modified by an administrator. This field will only show up when admin_change_user_info is `true`. The possible values are "name", "profile_picture", "sign_in_email" and "host_key". | |
| password_requirement | object | Enhanced password rules that allow Zoom account admins and owners to apply extra requirements to the user's Zoom login password. | |
| consecutive_characters_length | number | Number of consecutive identical characters allowed in a password. | |
| minimum_password_length | number | Specify a minimum length for the password. The password length can be from a minimum of 9 characters, up to 14 characters. | |
| have_special_character | boolean | If set to `true`, the password must have at least 1 special character (!, @, #, etc.). | |
| weak_enhance_detection | boolean | If set to `true`, users will be informed if the provided password is weak. | |
| import_photos_from_devices | boolean | Allow importing of photos from the photo library on the user's device. | |
| hide_billing_info | boolean | Hide billing information from administrators. | |
| admin_change_user_info | boolean | Only account administrators can change a user's information. |