Navigation: Schema: Accounts > Tables

AccountsByAccountIdSettings

Retrieve a sub account's settingsRetrieve a sub account's settings under the master account

Catalog: Zoom

Schema: Accounts

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: /accounts/{accountId}/settings

Insert Zoom API URL: /accounts/{accountId}/settings

Update Zoom API URL: /accounts/{accountId}/settings

Delete Zoom API URL: /accounts/{accountId}/settings

Field Selection Method: NotRequired

Select Zoom API Operation: get /accounts/{accountId}/settings

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function AccountsByAccountIdSettings. 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
accountId	string	☑		The account ID

Table Function Columns

The columns of the table function AccountsByAccountIdSettings are shown below. Each column has an SQL data type.

Name	Data Type	Required	Documentation
email_notification_alternative_host_reminder	boolean	☐	Notify when an alternative host is set or removed from a meeting
email_notification_cancel_meeting_reminder	boolean	☐	Notify host and participants when the meeting is cancelled
email_notification_cloud_recording_avaliable_reminder	boolean	☐	Notify host when cloud recording is available
email_notification_jbh_reminder	boolean	☐	Notify host when participants join the meeting before them
email_notification_low_host_count_reminder	boolean	☐	Notify when host licenses are running low
feature_meeting_capacity	int64	☐	Set the maximum number of participants this user can have in a single meeting
in_meeting_alert_guest_join	boolean	☐	Identify guest participants in the meeting/webinar
in_meeting_allow_live_streaming	boolean	☐	Allow live streaming
in_meeting_allow_show_zoom_windows	boolean	☐	Show Zoom Desktop application when sharing screen
in_meeting_annotation	boolean	☐	Allow participants to use annotation tools to add information to shared screens
in_meeting_anonymous_question_answer	boolean	☐	Allow Anonymous Q&A in Webinar
in_meeting_attendee_on_hold	boolean	☐	Allow hosts to temporarily remove an attendee from the meeting
in_meeting_attention_tracking	boolean	☐	Lets the host see an indicator in the participant panel if a meeting/webinar attendee does not have Zoom in focus during screen sharing
in_meeting_auto_answer	boolean	☐	Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.
in_meeting_auto_saving_chat	boolean	☐	Automatically save all in-meeting chats so that hosts do not need to manually save the text of the chat after the meeting starts
in_meeting_breakout_room	boolean	☐	Allow host to split meeting participants into separate, smaller rooms
in_meeting_chat	boolean	☐	Allow meeting participants to send a message visible to all participants
in_meeting_closed_caption	boolean	☐	Allow host to type closed captions or assign a participant/third party device to add closed captions
in_meeting_co_host	boolean	☐	Allow the host to add co-hosts
in_meeting_custom_live_streaming	boolean	☐	Custom live streaming
in_meeting_custom_service_instructions	string	☐	Custom service instructions
in_meeting_dscp_audio	int64	☐	DSCP Audio
in_meeting_dscp_marking	boolean	☐	DSCP marking
in_meeting_dscp_video	int64	☐	DSCP Video
in_meeting_e2e_encryption	boolean	☐	Require that all meetings are encrypted using AES
in_meeting_far_end_camera_control	boolean	☐	Allow another user to take control of your camera during a meeting
in_meeting_feedback	boolean	☐	Add a Feedback tab to the Windows Settings or Mac Preferences dialog, and also enable users to provide feedback to Zoom at the end of the meeting
in_meeting_file_transfer	boolean	☐	Hosts and participants can send files through the in-meeting chat
in_meeting_group_hd	boolean	☐	Activate higher quality video for host and participants. (This will use more bandwidth.)
in_meeting_original_audio	boolean	☐	Allow users to select original sound in their client settings
in_meeting_p2p_connetion	boolean	☐	Peer to Peer connection while only 2 people are in a meeting
in_meeting_p2p_ports	boolean	☐	P2P listening ports range
in_meeting_polling	boolean	☐	Add 'Polls' to the meeting controls.
in_meeting_ports_range	string	☐	Listening ports range, separated by comma (ex 55,56). The ports range must be between 1 to 65535.
in_meeting_post_meeting_feedback	boolean	☐	Display a thumbs up/down survey at the end of each meeting
in_meeting_private_chat	boolean	☐	Allow meeting participants to send a private 1:1 message to another participants
in_meeting_remote_control	boolean	☐	Allow users to request remote control
in_meeting_screen_sharing	boolean	☐	Allow screen sharing
in_meeting_sending_default_email_invites	boolean	☐	Only show default email when sending email invites
in_meeting_show_meeting_control_toolbar	boolean	☐	Always show meeting control toolbar
in_meeting_stereo_audio	boolean	☐	Allow users to select stereo audio in their client settings
in_meeting_use_html_format_email	boolean	☐	Use HTML format email for Outlook plugin
in_meeting_virtual_background	boolean	☐	Allow users to replace their background with any selected image. Choose or upload an image in the Zoom Desktop application settings.
in_meeting_watermark	boolean	☐	Add watermark when viewing shared screen
in_meeting_webinar_question_answer	boolean	☐	Q&A in webinar
in_meeting_whiteboard	boolean	☐	Allow participants to share a whiteboard that includes annotation tools
in_meeting_workplace_by_facebook	boolean	☐	Workplace by facebook
integration_box	boolean	☐	Enables users who join a meeting from their mobile device to share content from their Box account
integration_dropbox	boolean	☐	Enables users who join a meeting from their mobile device to share content from their Dropbox account
integration_google_calendar	boolean	☐	Enables meetings to be scheduled using Google Calendars
integration_google_drive	boolean	☐	Enables users who join a meeting from their mobile device to share content from their Google Drive
integration_kubi	boolean	☐	Enables users to control a connected Kubi device from within a Zoom meeting
integration_microsoft_one_drive	boolean	☐	Enables users who join a meeting from their mobile device to share content from their Microsoft OneDrive account
recording_account_user_access_recording	boolean	☐	Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.
recording_auto_delete_cmr_days	int64	☐	When `auto_delete_cmr` is 'true' this value will set the number of days before auto deletion of cloud recordings
recording_auto_delete_cmr	boolean	☐	Allow Zoom to automatically delete recordings permanently after a specified number of days
recording_auto_recording	string	☐	Record meetings automatically as they start
recording_cloud_recording_download_host	boolean	☐	Only the host can download cloud recordings
recording_cloud_recording_download	boolean	☐	Cloud Recording Downloads
recording_cloud_recording	boolean	☐	Allow hosts to record and save the meeting in the cloud
recording_local_recording	boolean	☐	Allow hosts and participants to record the meeting to a local file
recording_record_audio_file	boolean	☐	Record an audio only file
recording_record_gallery_view	boolean	☐	Record gallery view with shared screen
recording_record_speaker_view	boolean	☐	Record active speaker with shared screen
recording_recording_audio_transcript	boolean	☐	Automatically transcribe the audio of the meeting or webinar to the cloud
recording_save_chat_text	boolean	☐	Save chat text from the meeting
recording_show_timestamp	boolean	☐	Add a timestamp to the recording
schedule_meting_audio_type	string	☐	Determine how participants can join the audio portion of the meeting
schedule_meting_enforce_login_domains	string	☐	Only signed-in users with a specified domains
schedule_meting_enforce_login_with_domains	boolean	☐	Only signed-in users with a specific domain can join meetings
schedule_meting_enforce_login	boolean	☐	Only signed-in (Zoom users) users can join meetings
schedule_meting_force_pmi_jbh_password	boolean	☐	Require a password for Personal Meetings if attendees can join before host
schedule_meting_host_video	boolean	☐	Start meetings with host video on
schedule_meting_join_before_host	boolean	☐	Allow participants to join the meeting before the host arrives
schedule_meting_not_store_meeting_topic	boolean	☐	Always display "Zoom Meeting" as the meeting topic
schedule_meting_participant_video	boolean	☐	Start meetings with participant video on. Participants can change this during the meeting.
security_admin_change_name_pic	boolean	☐	Only account administrators can change user's username and picture
security_hide_billing_info	boolean	☐	Hide billing information
security_import_photos_from_devices	boolean	☐	Allow importing of photos from photo library on the user's device
telephony_audio_conference_info	string	☐	3rd party audio conference info
telephony_third_party_audio	boolean	☐	Users can join the meeting using the existing 3rd party audio configuration
zoom_rooms_auto_start_stop_scheduled_meetings	boolean	☐	Automatic start/stop for scheduled meetings
zoom_rooms_cmr_for_instant_meeting	boolean	☐	Cloud recording for instant meetings
zoom_rooms_force_private_meeting	boolean	☐	Transform all meetings to private
zoom_rooms_hide_host_information	boolean	☐	Hide host and meeting ID from private meetings
zoom_rooms_list_meetings_with_calendar	boolean	☐	Display meeting list with calendar integration
zoom_rooms_start_airplay_manually	boolean	☐	Start AirPlay service manually
zoom_rooms_ultrasonic	boolean	☐	Automatic direct sharing using ultrasonic proximity signal
zoom_rooms_upcoming_meeting_alert	boolean	☐	Upcoming meeting alert
zoom_rooms_weekly_system_restart	boolean	☐	Weekly system restart
zoom_rooms_zr_post_meeting_feedback	boolean	☐	Zoom Room post meeting feedback

16-06-2022 17:21 Version 22.1.46-BETA+3385

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Zoom API Data Model

AccountsByAccountIdSettings

Parameters of Table Function

Table Function Columns

Important Safety and Usage Information