| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| security | object | Locked security settings. | |
| waiting_room_settings | boolean | Lock the waiting room configuration settings. | |
| meeting_password | boolean | Lock whether all meetings require a password. | |
| pmi_password | boolean | Lock whether PMI meetings require a password. | |
| require_password_for_scheduled_webinar | boolean | Lock whether scheduled webinars require a password. | |
| auto_security | boolean | Lock whether all meetings must be secured with at least one security option. | |
| end_to_end_encrypted_meetings | boolean | Lock whether end-to-end encryption is required for all meetings. | |
| phone_password | boolean | Lock whether a password is required for participants joining by phone. | |
| only_authenticated_can_join_from_webclient | boolean | Lock whether only authenticated users can join from the web client. | |
| meeting_password_requirement | boolean | Lock meeting password requirement settings. | |
| chat_etiquette_tool | boolean | Lock whether the chat etiquette/keyword filtering tool is enabled. | |
| encryption_type | boolean | Lock the meeting encryption type setting. | |
| embed_password_in_join_link | boolean | Lock whether the meeting password is embedded in the join link. | |
| waiting_room | boolean | Lock whether the Waiting Room feature is enabled to hold participants before the host admits them. | |
| webinar_password | boolean | Lock whether webinars require a password. | |
| require_password_for_scheduled_meeting | boolean | Lock whether scheduled meetings require a password. | |
| block_user_domain | boolean | Lock whether users in specific domains are blocked from joining meetings. | |
| telephony | object | Locked telephony settings. | |
| third_party_audio | boolean | Lock whether third-party audio conferencing is enabled. | |
| telephony_regions | boolean | Lock the telephony regions setting. | |
| tsp | object | Locked third-party audio (TSP) settings. | |
| call_out | boolean | Lock whether call-out is enabled. | |
| show_international_numbers_link | boolean | Lock whether the international numbers link appears in meeting invitations. | |
| other_options | object | Locked miscellaneous settings. | |
| blur_snapshot | boolean | Lock whether the app blurs the Zoom window snapshot in the task switcher. | |
| allow_users_contact_support_via_chat | boolean | Lock whether users can contact Zoom support via chat during meetings. | |
| chat | object | Locked chat settings. | |
| allow_users_to_chat_with_others | boolean | Lock whether users can chat with external users. | |
| chat_etiquette_tool | boolean | Lock the chat etiquette tool. | |
| set_retention_period_in_cloud | boolean | Lock whether a cloud retention period for chats is set. | |
| set_retention_period_in_local | boolean | Lock whether a local retention period for chats is set. | |
| chat | boolean | Lock whether in-session chat is enabled. | |
| share_files | boolean | Lock whether file sharing is enabled in chat. | |
| create_public_channels | boolean | Lock whether users can create public channels. | |
| create_private_channels | boolean | Lock whether users can create private channels. | |
| allow_users_to_add_contacts | boolean | Lock whether users can add contacts. | |
| schedule_meeting | object | Locked meeting scheduling settings. | |
| personal_meeting | boolean | Lock whether the Personal Meeting setting is enabled. | |
| meeting_password_requirement | boolean | Lock the meeting password requirement settings. | |
| always_display_zoom_meeting_as_topic | boolean | Lock whether meeting topics always display as Zoom Meeting. | |
| require_password_for_instant_meetings | boolean | Lock whether a password is required for instant meetings. | |
| require_password_for_pmi_meetings | boolean | Lock whether a password is required for meetings using a Personal Meeting ID. | |
| hide_meeting_description | boolean | Lock whether meeting descriptions are hidden from participants. | |
| participant_video | boolean | Lock whether meetings start with participant video on. | |
| join_before_host | boolean | Lock whether participants can join the meeting before the host arrives. | |
| mute_upon_entry | boolean | Lock whether participants are muted upon entry. | |
| force_pmi_jbh_password | boolean | Lock whether a password is required for PMI meetings when joining before host is enabled. | |
| require_password_for_scheduled_meetings | boolean | Lock whether a password is required for previously scheduled meetings. | |
| jbh_time | boolean | Lock the join before host time setting. | |
| continuous_meeting_chat | boolean | Lock whether continuous meeting chat is enabled. | |
| host_video | boolean | Lock whether meetings start with host video on. | |
| enforce_login | boolean | Lock whether only signed-in Zoom users can join meetings. | |
| require_password_for_scheduling_new_meetings | boolean | Lock whether a password is required when scheduling new meetings. | |
| audio_type | boolean | Lock the audio type setting for meetings. | |
| embed_password_in_join_link | boolean | Lock whether the meeting password is embedded in the invite link. | |
| email_notification | object | Locked email notification settings. | |
| jbh_reminder | boolean | Lock whether hosts are notified when participants join before the host. | |
| cancel_meeting_reminder | boolean | Lock whether hosts and participants are notified when a meeting is cancelled. | |
| alternative_host_reminder | boolean | Lock whether a notification is sent when an alternative host is set or removed. | |
| schedule_for_reminder | boolean | Lock whether the host receives a reminder when a meeting is scheduled for them. | |
| recording_available_reminder_alternative_hosts | boolean | Lock whether alternative hosts are notified when a cloud recording is available. | |
| recording_available_reminder_schedulers | boolean | Lock whether meeting schedulers are notified when a cloud recording is available. | |
| cloud_recording_available_reminder | boolean | Lock whether hosts are notified when a cloud recording becomes available. | |
| recording | object | Locked recording settings. | |
| optimize_recording_for_3rd_party_video_editor | boolean | Lock whether recordings are optimized for third-party video editing. | |
| show_timestamp | boolean | Lock whether timestamps are shown in cloud recordings. | |
| save_panelist_chat | boolean | Lock whether panelist chat is saved with webinar recordings. | |
| recording_thumbnails | boolean | Lock whether recording thumbnails are enabled. | |
| recording_highlight | boolean | Lock whether recording highlights are enabled. | |
| ip_address_access_control | boolean | Lock whether cloud recording access is restricted by IP address. | |
| archive | boolean | Lock whether meeting/webinar archiving is enabled. | |
| host_pause_stop_recording | boolean | Lock whether hosts can pause or stop cloud recording. | |
| account_user_access_recording | boolean | Lock whether account users can access other users' cloud recordings. | |
| cloud_recording | boolean | Lock whether hosts can record and save the meeting in the cloud. | |
| display_participant_name | boolean | Lock whether participant names are displayed in cloud recordings. | |
| record_speaker_view | boolean | Lock whether active speaker view is included in cloud recordings. | |
| record_audio_file | boolean | Lock whether an audio-only file is created during recording. | |
| recording_password_requirement | boolean | Lock recording password requirement settings. | |
| local_recording | boolean | Lock whether hosts and participants can record the meeting to a local file. | |
| cloud_recording_download | boolean | Lock whether downloading of cloud recordings is enabled. | |
| recording_audio_transcript | boolean | Lock whether automatic audio transcription is enabled for cloud recordings. | |
| save_chat_text | boolean | Lock whether chat text is saved with cloud recordings. | |
| save_close_caption | boolean | Lock whether closed captions are saved with cloud recordings. | |
| record_files_separately | boolean | Lock whether different recording views are saved as separate files. | |
| smart_recording | boolean | Lock whether AI smart recording features are enabled. | |
| auto_recording | boolean | Lock whether meetings are automatically recorded. | |
| host_delete_cloud_recording | boolean | Lock whether hosts are allowed to delete their cloud recordings. | |
| required_password_for_shared_cloud_recordings | boolean | Lock whether a passcode is required to access shared cloud recordings. | |
| recording_disclaimer | boolean | Lock whether a disclaimer is shown to participants before recording starts. | |
| auto_delete_cmr | boolean | Lock whether cloud recordings are automatically deleted. | |
| record_gallery_view | boolean | Lock whether gallery view is included in cloud recordings. | |
| save_poll_results | boolean | Lock whether poll results are saved with cloud recordings. | |
| audio_conferencing | object | Locked audio conferencing settings. | |
| global_dial_in_countries | boolean | Lock the global dial-in countries setting. | |
| participant_phone_masking | boolean | Lock whether participant phone numbers are masked. | |
| toll_free_and_fee_based_toll_call | boolean | Lock whether toll-free and fee-based toll calls are enabled. | |
| call_me_and_invite_by_phone | boolean | Lock whether call-me and invite-by-phone features are enabled. | |
| in_meeting | object | Locked in-meeting settings. | |
| ai_companion_questions | object | Lock settings for AI Companion Q&A in meetings. | |
| locked | boolean | Whether the AI Companion Q&A setting is locked for meetings. | |
| auto_enable_locked | boolean | Whether auto-enable is locked for meeting Q&A. | |
| who_can_ask_questions_locked | boolean | Whether who-can-ask-questions is locked. | |
| dscp_marking | boolean | Lock whether DSCP marking is enabled. | |
| auto_saving_chat | boolean | Lock whether all in-meeting chats are automatically saved. | |
| sign_language_interpretation | boolean | Lock whether sign language interpretation is enabled for meetings. | |
| webinar_question_answer | boolean | Lock whether Q&A is enabled for webinars. | |
| virtual_background_settings | boolean | Lock virtual background settings. | |
| allow_host_panelists_to_use_audible_clap | boolean | Lock whether hosts and panelists can use the audible clap feature. | |
| screen_sharing | boolean | Lock whether the host and participants can share their screen during meetings. | |
| non_verbal_feedback | boolean | Lock whether participants can communicate using non-verbal feedback and reactions. | |
| workplace_by_facebook | boolean | Lock whether Workplace by Facebook live streaming is enabled. | |
| webinar_chat | boolean | Lock whether chat is enabled for webinars. | |
| webinar_group_hd | boolean | Lock whether HD video is enabled for webinar panelists. | |
| allow_live_streaming | boolean | Lock whether meetings can be live streamed. | |
| remote_support | boolean | Lock whether the host can provide remote support to a participant during a meeting. | |
| webinar_live_streaming | boolean | Lock whether webinar live streaming is enabled. | |
| far_end_camera_control | boolean | Lock whether a participant can control another's camera during a meeting. | |
| group_hd | boolean | Lock whether Group HD Video is enabled. | |
| custom_live_streaming_service | boolean | Lock whether custom live streaming is enabled. | |
| webinar_survey | boolean | Lock whether post-webinar surveys are enabled. | |
| disable_screen_sharing_for_in_meeting_guests | boolean | Lock whether screen sharing is disabled when guests are in the meeting. | |
| attention_mode_focus_mode | boolean | Lock whether focus mode is enabled during meetings. | |
| show_a_join_from_your_browser_link | boolean | Lock whether the join from browser link is shown. | |
| meeting_summary_with_ai_companion | object | Lock settings for AI Companion meeting summary. | |
| locked | boolean | Whether the meeting summary AI Companion setting is locked. | |
| auto_enable_locked | boolean | Whether auto-enable is locked for meeting summary. | |
| who_will_receive_summary_locked | boolean | Whether who-receives-summary is locked. | |
| annotation | boolean | Lock whether participants can use annotation tools when sharing their screen. | |
| feedback | boolean | Lock whether participants can send feedback to Zoom at the end of meetings. | |
| who_can_share_screen | boolean | Lock who can share their screen during meetings. | |
| webinar_polling | boolean | Lock whether webinar polling is enabled. | |
| disable_screen_sharing_for_host_meetings | boolean | Lock whether screen sharing is disabled for host meetings. | |
| remote_control | boolean | Lock whether others can take control of a shared screen. | |
| allow_show_zoom_windows | boolean | Lock whether Zoom windows can be shown during screen sharing. | |
| meeting_polling | boolean | Lock whether meeting polling is enabled. | |
| transfer_meetings_between_devices | boolean | Lock whether participants can transfer meetings between devices. | |
| share_dual_camera | boolean | Lock whether participants can share a second camera. | |
| meeting_reactions | boolean | Lock whether meeting reactions are enabled. | |
| live_streaming_youtube | boolean | Lock whether YouTube live streaming is enabled. | |
| whiteboard | boolean | Lock whether the whiteboard feature is enabled during meetings. | |
| virtual_background | boolean | Lock whether users can replace their background with a virtual image. | |
| polling | boolean | Lock whether the host can add polls to a meeting. | |
| meeting_survey | boolean | Lock whether post-meeting surveys are enabled. | |
| meeting_question_answer | boolean | Lock whether Q&A is enabled for meetings. | |
| join_from_mobile | boolean | Lock whether participants can join from their mobile browser. | |
| allow_participants_to_rename | boolean | Lock whether participants can rename themselves during a meeting. | |
| slide_control | boolean | Lock whether participants can control slide presentations during meetings. | |
| anonymous_question_answer | boolean | Lock whether anonymous Q&A is enabled in webinars. | |
| manual_captioning | boolean | Lock whether manual captioning is enabled. | |
| custom_data_center_regions | boolean | Lock whether custom data center region selection is enabled. | |
| chat | boolean | Lock whether meeting participants can send messages visible to all participants. | |
| attendee_on_hold | boolean | Lock whether the host can put attendees on hold. | |
| live_streaming_facebook | boolean | Lock whether Facebook live streaming is enabled. | |
| allow_participants_chat_with | boolean | Lock the setting controlling who participants can chat with. | |
| breakout_room_schedule | boolean | Lock whether hosts can schedule breakout rooms. | |
| allow_users_save_chats | boolean | Lock how participants can save meeting chats. | |
| closed_captioning | boolean | Lock whether closed captioning is enabled. | |
| webinar_ai_companion_questions | object | Lock settings for AI Companion Q&A in webinars. | |
| locked | boolean | Whether the AI Companion Q&A setting is locked for webinars. | |
| auto_enable_locked | boolean | Whether auto-enable is locked for webinar Q&A. | |
| who_can_ask_questions_locked | boolean | Whether who-can-ask-questions is locked for webinars. | |
| closed_caption | boolean | Lock whether a host can enable closed captions for a meeting. | |
| co_host | boolean | Lock whether hosts can designate co-hosts during meetings. | |
| participants_share_simultaneously | boolean | Lock whether multiple participants can share screens simultaneously. | |
| language_interpretation | boolean | Lock whether language interpretation is enabled for meetings. | |
| allow_users_to_delete_messages_in_meeting_chat | boolean | Lock whether users can delete their meeting chat messages. | |
| original_audio | boolean | Lock whether original audio is allowed during meetings. | |
| stereo_audio | boolean | Lock whether stereo audio is allowed during meetings. | |
| private_chat | boolean | Lock whether participants can send private messages to one another. | |
| allow_host_to_enable_focus_mode | boolean | Lock whether hosts can enable focus mode during meetings. | |
| group_hd_video | boolean | Lock whether Group HD Video quality is enabled. | |
| p2p_ports | boolean | Lock whether custom peer-to-peer ports are used. | |
| file_transfer | boolean | Lock whether in-meeting file transfer is enabled. | |
| e2e_encryption | boolean | Lock whether end-to-end encryption is required for meetings. | |
| who_can_share_screen_when_someone_is_sharing | boolean | Lock who can start sharing when someone is already sharing. | |
| entry_exit_chime | boolean | Lock the entry/exit chime setting for meetings. | |
| webinar_reactions | boolean | Lock whether webinar reactions are enabled. | |
| post_meeting_feedback | boolean | Lock whether post-meeting feedback survey is shown. | |
| join_from_desktop | boolean | Lock whether participants can join from their desktop browser. | |
| breakout_room | boolean | Lock whether the host can split participants into separate breakout rooms. | |
| show_meeting_control_toolbar | boolean | Lock whether the meeting control toolbar is always visible. | |
| waiting_room | boolean | Lock whether waiting room is enabled in meetings. | |
| webinar_summary_with_ai_companion | object | Lock settings for AI Companion webinar summary. | |
| locked | boolean | Whether the webinar summary AI Companion setting is locked. | |
| auto_enable_locked | boolean | Whether auto-enable is locked for webinar summary. | |
| who_will_receive_summary_locked | boolean | Whether who-receives-summary is locked. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| smart_recognition | object | Smart recognition settings using AI-based audio and video identification. | |
| personalized_audio_isolation | boolean | Whether personalized audio isolation using voice recognition is enabled. | |
| workplace_app | object | Smart recognition settings for the Zoom Workplace app. | |
| voice_name_tags | object | Voice name tag settings for the Zoom Workplace app. | |
| allow_enrollment_email | boolean | Whether enrollment email is allowed for voice name tags in the Zoom app. | |
| enabled | boolean | Whether voice name tags are enabled in the Zoom app. | |
| zoom_rooms | object | Smart recognition settings for Zoom Rooms. | |
| video_name_tags | object | Video name tag settings for Zoom Rooms. | |
| allow_user_photos | boolean | Whether user photos are used for video name tag identification. | |
| enabled | boolean | Whether video name tags are enabled in Zoom Rooms. | |
| allow_enrollment_email | boolean | Whether enrollment email is allowed for video name tags in Zoom Rooms. | |
| allow_external_identification | boolean | Whether external user identification via video is allowed. | |
| voice_name_tags | object | Voice name tag settings for Zoom Rooms. | |
| allow_enrollment_email | boolean | Whether enrollment email is allowed for voice name tags in Zoom Rooms. | |
| allow_external_identification | boolean | Whether external user identification via voice is allowed in Zoom Rooms. | |
| enabled | boolean | Whether voice name tags are enabled in Zoom Rooms. | |
| feature | object | Account feature capacity settings. | |
| meeting_capacity | number | Maximum meeting capacity for the account. | |
| schedule_meeting | object | Meeting scheduling settings. | |
| require_password_for_instant_meetings | boolean | Require a password for instant meetings. | |
| jbh_time | number | Minutes before the host that participants can join when join-before-host is enabled. | |
| meeting_template | object | Meeting template settings. | |
| enable | boolean | Whether meeting templates are enabled. | |
| templates | list<object> | List of available meeting templates. | |
| enable | boolean | Whether this template is enabled. | |
| id | string | Template ID. | |
| name | string | Template name. | |
| meeting_password_requirement | object | Password complexity requirements for meetings. | |
| consecutive_characters_length | number | Maximum number of consecutive characters allowed in the meeting password. | |
| have_letter | boolean | Whether the meeting password must contain at least one letter. | |
| have_number | boolean | Whether the meeting password must contain at least one number. | |
| have_special_character | boolean | Whether the meeting password must contain at least one special character. | |
| have_upper_and_lower_characters | boolean | Whether the meeting password must contain both uppercase and lowercase characters. | |
| length | number | Minimum length of the meeting password. | |
| only_allow_numeric | boolean | Whether only numeric passwords are allowed (for PSTN users). | |
| weak_enhance_detection | boolean | Whether weak password detection enhancement is enabled. | |
| hide_meeting_description | object | Settings for hiding meeting descriptions from participants. | |
| enable | boolean | Whether meeting descriptions are hidden from participants. | |
| enforce_login_with_domains | boolean | Whether login is required only for users from specific domains. | |
| mute_upon_entry | boolean | Whether participants are muted upon entry into the meeting. | |
| continuous_meeting_chat | object | Persistent meeting chat settings that continue after the meeting ends. | |
| auto_add_invited_external_users | boolean | Whether invited external users are automatically added to the persistent meeting chat. | |
| can_add_external_users | boolean | Whether external users can be added to the persistent meeting chat. | |
| enable | boolean | Whether persistent/continuous meeting chat is enabled. | |
| use_pmi_for_scheduled_meetings | boolean | Use the Personal Meeting ID (PMI) when scheduling a meeting. | |
| use_pmi_for_instant_meetings | boolean | Use the Personal Meeting ID (PMI) when starting an instant meeting. | |
| enable_dedicated_group_chat | boolean | Whether a dedicated group chat is created for each meeting. | |
| force_pmi_jbh_password | boolean | Whether a password is required for PMI meetings when join-before-host is enabled. | |
| enforce_login_domains | string | Comma-separated list of domains from which users must be signed in to join. | |
| always_display_zoom_meeting_as_topic | object | Settings for always displaying a generic meeting topic. | |
| enable | boolean | Whether to always display "Zoom Meeting" as the meeting topic. | |
| display_topic_for_scheduled_meetings | boolean | Whether to display the generic topic for scheduled meetings. | |
| host_video | boolean | Start meetings with the host video on. | |
| require_password_for_pmi_meetings | string | Require a password for a meeting held using a Personal Meeting ID (PMI). | |
| hide_webinar_description | object | Settings for hiding webinar descriptions. | |
| enable | boolean | Whether to hide webinar descriptions. | |
| hide_description_for_scheduled_webinars | boolean | Whether descriptions are hidden for scheduled webinars. | |
| require_password_for_scheduled_meetings | boolean | Whether scheduled meetings require a password. | |
| audio_type | string | Determines how participants can join the audio portion of meetings (both, telephony, voip, third-party). | |
| embed_password_in_join_link | boolean | Whether the meeting password is embedded in the join meeting link. | |
| allow_host_to_disable_participant_video | boolean | Whether the host can disable participant video during a meeting. | |
| always_display_zoom_webinar_as_topic | object | Settings for always displaying a generic webinar topic. | |
| enable | boolean | Whether to always display "Zoom Webinar" as the webinar topic. | |
| display_topic_for_scheduled_webinars | boolean | Whether to display topic for scheduled webinars. | |
| 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. | |
| participant_video | boolean | Start meetings with the participant video on. | |
| enforce_login | boolean | Only Zoom users who are signed in can join meetings. | |
| require_password_for_scheduling_new_meetings | boolean | Require a password when scheduling new meetings. | |
| 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. | |
| tsp | object | Account Settings - TSP. | |
| allow_webinar_attendees_toll_free_dial | boolean | Whether webinar attendees can use toll-free dial-in numbers. | |
| allow_webinar_attendees_call_me | boolean | Whether webinar attendees can use the call-me feature. | |
| call_out | boolean | Whether call-out is enabled for TSP. | |
| call_out_countries | list<string> | List of countries allowed for TSP call-out. | |
| global_dial_in_countries | object | Global dial-in country configuration for TSP. | |
| allowed_countries | list<object> | List of allowed global TSP dial-in countries. | |
| code | string | Country code. | |
| name | string | Country name. | |
| selected_countries | list<object> | List of selected global TSP dial-in countries. | |
| code | string | Country code. | |
| name | string | Country name. | |
| show_international_numbers_link | boolean | Show the link to international numbers on the invitation email. | |
| display_toll_free_numbers | boolean | Display toll-free numbers. | |
| integration | object | Third-party cloud storage and calendar integration settings. | |
| box | boolean | Whether Box cloud storage integration is enabled. | |
| dropbox | boolean | Whether Dropbox cloud storage integration is enabled. | |
| google_calendar | boolean | Whether Google Calendar integration is enabled. | |
| google_drive | boolean | Whether Google Drive integration is enabled. | |
| kubi | boolean | Whether Kubi video device integration is enabled. | |
| microsoft_one_drive | boolean | Whether Microsoft OneDrive integration is enabled. | |
| recording_authentication | boolean | Whether only authenticated users can view cloud recordings. | |
| telephony | object | Account telephony settings. | |
| telephony_regions | object | Telephony region availability and selection. | |
| allowed_values | list<string> | Available telephony regions. | |
| selection_values | string | Currently selected telephony regions. | |
| third_party_audio | boolean | Whether third-party audio conferencing is enabled. | |
| audio_conference_info | string | Third-party audio conference connection details. | |
| general_setting | object | General account-level settings. | |
| auto_zoom_room_proximity_connect | boolean | Whether Zoom Rooms automatically connect via proximity detection. | |
| show_zoom_room_feature | boolean | Whether Zoom Rooms features are shown in the account settings. | |
| mail_calendar | object | Zoom Mail and Calendar integration settings. | |
| email_calendar_management | boolean | Whether Zoom Mail and Calendar management is enabled. | |
| email_management | boolean | Whether Zoom Mail management is enabled. | |
| zoom_email_provider | boolean | Whether Zoom is used as the email provider. | |
| in_meeting | object | In-meeting settings. | |
| allow_live_streaming | boolean | Allow live streaming of meetings. | |
| polling | boolean | Allow hosts to add polls/quizzes before or during a meeting | |
| disable_screen_sharing_for_in_meeting_guests | boolean | Whether screen sharing is disabled when guests are present in a meeting. | |
| meeting_polling | object | Meeting polling and quiz settings. | |
| enable | boolean | Whether meeting polling is enabled. | |
| manage_saved_polls_and_quizzes | boolean | Whether hosts can manage saved polls and quizzes. | |
| require_answers_to_be_anonymous | boolean | Whether poll answers must be anonymous. | |
| advanced_polls | boolean | Whether advanced polls and quizzes are enabled. | |
| allow_alternative_host_to_add_edit | boolean | Whether alternative hosts can add or edit polls. | |
| allow_host_to_upload_image | boolean | Whether hosts can upload images in polls. | |
| sign_language_interpretation | object | Sign language interpretation settings for meetings. | |
| custom_languages | list<string> | List of custom sign languages available for interpretation. | |
| enable | boolean | Whether sign language interpretation is enabled. | |
| enable_sign_language_interpretation_by_default | boolean | Whether sign language interpretation is enabled by default. | |
| languages | list<string> | List of available sign languages for interpretation. | |
| webinar_group_hd | boolean | Whether group HD video is enabled for webinars. | |
| webinar_polling | object | Webinar polling and quiz settings. | |
| allow_alternative_host_to_add_edit | boolean | Whether alternative hosts can add or edit webinar polls. | |
| allow_host_to_upload_image | boolean | Whether hosts can upload images in webinar polls. | |
| enable | boolean | Whether webinar polling is enabled. | |
| manage_saved_polls_and_quizzes | boolean | Whether hosts can manage saved webinar polls and quizzes. | |
| require_answers_to_be_anonymous | boolean | Whether webinar poll answers must be anonymous. | |
| advanced_polls | boolean | Whether advanced polls and quizzes are enabled for webinars. | |
| webinar_reactions | boolean | Whether emoji reactions are enabled for webinars. | |
| 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. | |
| 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. | |
| remote_support | boolean | Allow the host to provide remote support to another participant during a meeting. | |
| group_hd | boolean | Whether group HD video is enabled for meetings. | |
| webinar_ai_companion_questions | object | AI Companion Q&A feature settings for webinars. | |
| auto_enable | boolean | Whether AI Companion Q&A is automatically enabled for webinars. | |
| enable | boolean | Whether AI Companion Q&A feature is enabled for webinars. | |
| who_can_ask_questions | number | Who can ask questions in webinar AI Q&A. | |
| private_chat | boolean | Allow a meeting participant to send a private message to another participant. | |
| allow_host_panelists_to_use_audible_clap | boolean | Whether hosts and panelists can use audible clap reactions. | |
| custom_live_streaming_service | boolean | Whether custom live streaming services are allowed for meetings. | |
| dscp_audio | number | DSCP value for meeting audio traffic. | |
| original_audio | boolean | Whether original audio (without echo cancellation) is enabled. | |
| entry_exit_chime | string | Play sound when participants join or leave. | |
| chat | boolean | Allow meeting participants to send a message that is visible to all participants. | |
| auto_generated_translation | object | Auto-generated translation settings for meetings. | |
| enable | boolean | Whether auto-generated translation is enabled. | |
| language_item_pairList | object | Language pair list for auto-generated translation. | |
| trans_lang_config | list<object> | Translation language pair configurations. | |
| translate_to | object | Target language translation settings. | |
| all | boolean | Whether to translate to all available languages. | |
| language_config | list<object> | List of target language configurations. | |
| code | string | Target language code. | |
| name | string | Target language name. | |
| speak_language | object | The spoken language configuration. | |
| code | string | Spoken language code. | |
| name | string | Spoken language name. | |
| all | boolean | Whether all language pairs are enabled. | |
| breakout_room_schedule | boolean | Whether hosts can pre-assign participants to breakout rooms when scheduling. | |
| live_streaming_facebook | boolean | Whether Facebook Live streaming is enabled for meetings. | |
| watermark_by_default | boolean | Whether watermarks are enabled by default for all meetings. | |
| alert_guest_join | boolean | Identify guest participants in a meeting or webinar. | |
| watermark | boolean | Add a watermark when viewing a shared screen. | |
| 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. | |
| 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. | |
| use_html_format_email | boolean | Use HTML formatted email for the Outlook plugin. | |
| custom_service_instructions | string | Instructions for custom live streaming service setup. | |
| ports_range | string | Custom port range for P2P connections. | |
| audio_watermark_by_default | boolean | Whether audio watermarks are enabled by default to identify the source of a leaked recording. | |
| screen_sharing | boolean | Allow the host and participants to share their screen or content during 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. | |
| live_streaming_youtube | boolean | Whether YouTube Live streaming is enabled for meetings. | |
| meeting_summary_with_ai_companion | object | AI Companion meeting summary settings. | |
| auto_enable | boolean | Whether AI meeting summary is automatically enabled. | |
| enable | boolean | Whether AI meeting summary feature is enabled. | |
| who_will_receive_summary | number | Who receives the AI-generated meeting summary (0=host only, 1=all participants). | |
| unchecked_data_center_regions | list<string> | Data center regions explicitly unchecked for meeting routing. | |
| virtual_background_settings | object | Settings to manage virtual backgrounds. | |
| enable | boolean | Whether virtual background feature is enabled. | |
| files | list<object> | List of available virtual background files. | |
| id | string | Virtual background file ID. | |
| is_default | boolean | Whether this is the default virtual background. | |
| name | string | Virtual background file name. | |
| size | number | Virtual background file size in bytes. | |
| type | string | Virtual background file type (image or video). | |
| allow_videos | boolean | Allow use of videos for virtual backgrounds. | |
| allow_upload_custom | boolean | Allow users to upload custom backgrounds. | |
| webinar_question_answer | boolean | Whether Q&A feature is enabled for webinars. | |
| show_meeting_control_toolbar | boolean | Always show the meeting controls during a meeting. | |
| virtual_background | boolean | Allow users to replace their background with any selected image. | |
| non_verbal_feedback | boolean | Allow meeting participants to communicate using non-verbal feedback and reactions. | |
| closed_captioning | object | Settings for closed captioning and transcript saving. | |
| third_party_captioning_service | boolean | Whether third-party captioning services are allowed. | |
| view_full_transcript | boolean | Whether participants can view the full transcript during a meeting. | |
| save_caption | boolean | Allow participants to save closed captions or transcripts during a meeting. | |
| auto_transcribing | boolean | Whether automatic transcription of closed captions is enabled. | |
| enable | boolean | Whether closed captioning is enabled for meetings. | |
| anonymous_question_answer | boolean | Whether anonymous Q&A is enabled for meetings and webinars. | |
| stereo_audio | boolean | Whether stereo audio is enabled for meetings. | |
| whiteboard | boolean | Allow participants to share a whiteboard that includes annotation tools. | |
| sending_default_email_invites | boolean | Allow users to invite participants by email only by using the default email program selected on their computer. | |
| join_from_mobile | boolean | Whether joining from mobile devices is enabled. | |
| slide_control | boolean | Whether slide control sharing is enabled for meetings. | |
| waiting_room | boolean | Whether the waiting room is enabled for meetings. | |
| allow_show_zoom_windows | boolean | Show the Zoom desktop application when sharing screens. | |
| meeting_reactions | boolean | Enable or disable meeting reactions. | |
| annotation | boolean | Allow participants to use annotation tools to add information while sharing their screen. | |
| dscp_marking | boolean | Whether DSCP QoS marking is enabled for meetings. | |
| dscp_video | number | DSCP value for meeting video traffic. | |
| language_interpretation | object | Language interpretation settings for meetings. | |
| custom_languages | list<string> | List of custom languages available for interpretation. | |
| enable | boolean | Whether language interpretation is enabled for meetings. | |
| enable_language_interpretation_by_default | boolean | Whether language interpretation is enabled by default for new meetings. | |
| languages | list<string> | List of available languages for interpretation. | |
| allow_participants_to_speak_in_listening_channel | boolean | Whether participants can speak in the listening language channel. | |
| allow_up_to_25_custom_languages_when_scheduling_meetings | boolean | Whether up to 25 custom languages can be used when scheduling meetings. | |
| transfer_meetings_between_devices | boolean | Whether participants can transfer a meeting between their devices. | |
| 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. | |
| custom_data_center_regions | boolean | Whether to enable the use of customized data center regions for meetings and webinars. | |
| attendee_on_hold | boolean | Whether the host can place attendees on hold. | |
| meeting_data_transit_and_residency_method | string | Method for meeting data transit and residency compliance. | |
| p2p_ports | boolean | Whether custom P2P ports are configured for meetings. | |
| remote_control | boolean | When screen sharing, the person who is sharing can allow others to control the shared content. | |
| co_host | boolean | Allow the host to add co-hosts. | |
| allow_participants_chat_with | number | Who participants can send in-meeting chat messages to (1=host only, 2=everyone, 3=everyone and direct). | |
| dscp_dual | boolean | Whether dual DSCP marking is enabled for meetings. | |
| participants_share_simultaneously | string | Whether multiple participants can share simultaneously. | |
| post_meeting_feedback | boolean | Whether post-meeting feedback survey is shown to participants. | |
| who_can_share_screen | string | Indicates who can share their screen or content during meetings. | |
| allow_users_save_chats | number | Controls who can save in-meeting chats. 0 = host only, 1 = everyone, 2 = no one. | |
| allow_host_to_enable_focus_mode | boolean | Whether the host can enable Focus Mode to hide participants from each other. | |
| disable_screen_sharing_for_host_meetings | boolean | Whether desktop screen sharing is disabled for hosts in meetings. | |
| webinar_chat | object | Webinar chat settings. | |
| allow_users_to_delete_messages_in_meeting_chat | boolean | Whether users can delete their messages in webinar chat. | |
| default_attendees_chat_with | number | Default setting for who attendees chat with. | |
| enable | boolean | Whether webinar chat is enabled. | |
| allow_attendees_chat_with | number | Who webinar attendees can chat with (1=host/panelists only, 2=everyone). | |
| allow_auto_save_local_chat_file | boolean | Whether local chat files are automatically saved. | |
| allow_panelists_chat_with | number | Who webinar panelists can chat with. | |
| allow_panelists_send_direct_message | boolean | Whether panelists can send direct messages to attendees. | |
| allow_users_save_chats | number | Who can save webinar chat (0=nobody, 1=host/panelists, 2=everyone). | |
| 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. | |
| 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. | |
| data_center_regions | list<string> | Selected data center regions for meeting routing. | |
| far_end_camera_control | boolean | Allow another user to take control of your camera during a meeting. | |
| manual_captioning | object | Information about manual captioning settings. | |
| 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. | |
| 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. | |
| p2p_connetion | boolean | Allow users to directly connect to one another in a 2-person meeting. | |
| webinar_live_streaming | object | Webinar live streaming settings. | |
| custom_service_instructions | string | Instructions for custom webinar live streaming service. | |
| enable | boolean | Whether webinar live streaming is enabled. | |
| live_streaming_reminder | boolean | Whether a reminder is shown before webinar live streaming starts. | |
| live_streaming_service | list<string> | List of enabled webinar live streaming services. | |
| webinar_summary_with_ai_companion | object | AI Companion webinar summary settings. | |
| auto_enable | boolean | Whether AI webinar summary is automatically enabled. | |
| enable | boolean | Whether AI webinar summary feature is enabled. | |
| who_will_receive_summary | number | Who receives the AI-generated webinar summary. | |
| participants_to_place_in_waiting_room | number | Who is placed in the waiting room: 0 = all, 1 = guests only, 2 = external users. | |
| 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. | |
| attention_mode_focus_mode | boolean | Whether attention/focus mode is enabled. | |
| join_from_desktop | boolean | Whether joining from the desktop application is enabled. | |
| meeting_reactions_emojis | string | Which emojis are available for meeting reactions (all or selected set). | |
| meeting_survey | boolean | Whether meeting surveys are enabled. | |
| webinar_survey | boolean | Whether post-webinar surveys are enabled. | |
| workplace_by_facebook | boolean | Whether Workplace by Facebook live streaming is enabled. | |
| 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. | |
| file_transfer | boolean | Indicates whether the in-meeting file transfer setting has been enabled on the account or not. | |
| ai_companion_questions | object | AI Companion Q&A feature settings for meetings. | |
| auto_enable | boolean | Whether AI Companion Q&A is automatically enabled for meetings. | |
| enable | boolean | Whether AI Companion Q&A feature is enabled. | |
| who_can_ask_questions | number | Who can ask questions using AI Companion (0=all, 1=host/co-host only). | |
| meeting_question_answer | boolean | Whether Q&A feature is enabled for meetings. | |
| chat | object | Zoom Chat settings for the account. | |
| create_private_channels | boolean | Whether users can create private channels. | |
| download_file | boolean | Whether users can download files from chat. | |
| record_video_messages | boolean | Whether users can record video messages in chat. | |
| suppress_removal_notification | boolean | Whether removal notifications are suppressed. | |
| survey_poll | boolean | Whether survey/poll feature is enabled in Team Chat. | |
| code_snippet | boolean | Whether users can send code snippets in chat. | |
| hyper_link | boolean | Whether hyperlinks are enabled in chat messages. | |
| personal_channel | boolean | Whether personal channels are enabled. | |
| presence_away_when_screen_saver | boolean | Whether presence is set to away when screen saver is active. | |
| read_receipts | object | Read receipt settings for Team Chat. | |
| allow_users_opt_out | boolean | Whether users can opt out of read receipts. | |
| enable | boolean | Whether read receipts are enabled. | |
| record_voice_messages | boolean | Whether users can record voice messages in chat. | |
| schedule_meetings_in_chat | boolean | Whether users can schedule meetings directly from chat. | |
| suppress_user_group_notification | boolean | Whether user group notifications are suppressed. | |
| only_allow_specific_file_types | boolean | Whether to only allow specific file types when users send files in Zoom Chat. | |
| allow_users_to_add_contacts | object | Settings for who users can add as contacts. | |
| selected_option | number | Who users can add as contacts (0=nobody, 1=same org, 2=any Zoom user). | |
| user_email_addresses | string | Specific email addresses allowed to be added as contacts. | |
| enable | boolean | Whether users can add contacts. | |
| chat_emojis | object | Chat emoji settings. | |
| emojis_option | string | Emoji option setting for chat. | |
| enable | boolean | Whether chat emojis are enabled. | |
| screen_capture | boolean | Whether screen capture is allowed in chat. | |
| send_data_to_third_party_archiving_service | object | Settings for sending chat data to a third-party archiving service. | |
| smtp_delivery_address | string | SMTP delivery address for the archiving service. | |
| type | string | Type of archiving service. | |
| user_name | string | Username for the archiving service. | |
| authorized_channel_token | string | Authorized channel token for the archiving service. | |
| enable | boolean | Whether sending data to third-party archiving service is enabled. | |
| passcode | string | Passcode for the archiving service. | |
| set_retention_period_in_cloud | object | Cloud message retention policy settings. | |
| enable | boolean | Whether cloud retention period is enforced. | |
| retention_period_of_channels | string | Retention period for channel messages. | |
| retention_period_of_direct_messages_and_group_conversation | string | Retention period for direct messages and group conversations. | |
| share_files | object | File sharing settings in Team Chat. | |
| enable | boolean | Whether file sharing is enabled in Team Chat. | |
| restrictions | object | File sharing restriction settings. | |
| file_size_restrictions | number | Maximum file size (MB) for internal users. | |
| file_size_restrictions_for_external | number | Maximum file size (MB) for external users. | |
| file_type_restrictions | list<string> | List of allowed file types for internal users. | |
| file_type_restrictions_for_external | list<string> | List of allowed file types for external users. | |
| maximum_file_size | boolean | Whether a maximum file size restriction is enforced. | |
| only_allow_specific_file_types | boolean | Whether to restrict to only specific file types. | |
| file_restrictions_apply_to | string | Who file restrictions apply to (internal/external/all). | |
| share_option | string | Who can share files in chat. | |
| view_option | string | Who can view shared files. | |
| share_screen_in_chat | boolean | Whether users can share their screen in chat. | |
| external_member_join | object | Settings for external members joining channels. | |
| enable | boolean | Whether external members can join channels. | |
| external_account | boolean | Whether external account members can join. | |
| external_user_control | object | Settings for controlling external user access. | |
| external_account | boolean | Whether control applies to external accounts. | |
| selected_option | number | Control option selected. | |
| enable | boolean | Whether external user control is enabled. | |
| ai_summary | object | AI summary settings for Team Chat. | |
| enable | boolean | Whether AI summary is enabled in Team Chat. | |
| shown_in_team_chat | boolean | Whether AI summary is shown in Team Chat. | |
| allow_delete_message | object | Message deletion settings. | |
| enable | boolean | Whether users can delete messages. | |
| time | number | Time window (minutes) in which messages can be deleted. | |
| set_retention_period_in_local | object | Local message retention policy settings. | |
| enable | boolean | Whether local retention period is enforced. | |
| retention_period_of_channels | string | Local retention period for channel messages. | |
| retention_period_of_direct_messages_and_group_conversation | string | Local retention period for direct messages and group conversations. | |
| share_links_in_chat | boolean | Whether users can share links in chat. | |
| allow_users_to_chat_with_others | object | Settings controlling who users can chat with externally. | |
| user_email_addresses | string | Specific email addresses allowed for external chat. | |
| enable | boolean | Whether users can chat with users outside the account. | |
| selected_option | number | Who users can chat with (0=nobody, 1=same org, 2=any Zoom user, 3=all). | |
| apply_local_storage_to_personal_channel | object | Local storage retention settings for personal channels. | |
| enable | boolean | Whether local storage retention applies to personal channels. | |
| retention_period | string | Retention period for personal channel messages. | |
| set_chat_as_default_tab | boolean | Whether Team Chat is set as the default tab in the Zoom application. | |
| store_revise_chat | boolean | Whether chat revision history is stored. | |
| translate_messages | boolean | Whether message translation is enabled in Team Chat. | |
| allow_edit_message | object | Message editing settings. | |
| time | number | Time window (minutes) in which messages can be edited. | |
| enable | boolean | Whether users can edit messages. | |
| search_and_send_animated_gif_images | object | Settings for searching and sending animated GIF images. | |
| enable | boolean | Whether animated GIF image search and sending is enabled. | |
| giphy_content_rating | number | Giphy content rating level (0=G, 1=PG, 2=PG-13, 3=R). | |
| show_h323_contact_tab | boolean | Whether the H.323 contact tab is shown in chat. | |
| allow_bots_chat | boolean | Whether to allow Zoom Chat bots to send messages in chat. | |
| ai_compose | object | AI compose settings for Team Chat. | |
| enable | boolean | Whether AI compose is enabled in Team Chat. | |
| shown_in_team_chat | boolean | Whether AI compose is shown in Team Chat. | |
| ai_quick_schedule | boolean | Whether AI quick schedule is enabled in Team Chat. | |
| ai_recommend | boolean | Whether AI recommendations are enabled in Team Chat. | |
| chat_email_address | object | Chat email address settings. | |
| enable | boolean | Whether chat email address feature is enabled. | |
| only_allow_specific_domains | boolean | Whether to restrict to specific domains. | |
| specific_domains | list<string> | List of specific domains allowed. | |
| chat_etiquette_tool | object | Chat etiquette tool settings for Team Chat. | |
| enable | boolean | Whether the chat etiquette tool is enabled. | |
| policies | list<object> | List of chat etiquette policies. | |
| id | string | Policy ID. | |
| is_locked | boolean | Whether the policy is locked. | |
| keywords | list<string> | Keywords monitored by this policy. | |
| name | string | Policy name. | |
| regular_expression | string | Regular expression pattern for keyword matching. | |
| status | string | Policy status (active/inactive). | |
| trigger_action | number | Action to take when policy is triggered. | |
| description | string | Policy description. | |
| policy_max_count | number | Maximum number of chat etiquette policies allowed. | |
| create_public_channels | boolean | Whether users can create public channels. | |
| presence_on_meeting | boolean | Whether presence status shows when in a meeting. | |
| external_invite_approve | object | Settings for approving external invites to channels. | |
| channel_id | string | Channel ID for external invite approval. | |
| enable | boolean | Whether external invite approval is required. | |
| external_account | boolean | Whether approval applies to external accounts. | |
| external_join_approve | object | Settings for approving external users joining channels. | |
| channel_id | string | Channel ID for external join approval. | |
| enable | boolean | Whether external join approval is required. | |
| external_account | boolean | Whether approval applies to external accounts. | |
| allow_huddles_from_channels | boolean | Whether users can start huddles from channels. | |
| allow_remove_msg_by_owner_and_admins | boolean | Whether channel owners and admins can remove messages. | |
| create_group_chat | boolean | Whether users can create group chats. | |
| external_collab_restrict | object | Settings restricting external collaboration in Team Chat. | |
| external_chat | string | External chat restriction setting. | |
| group_id | string | Group ID for external collaboration restriction. | |
| enable | boolean | Whether external collaboration restriction is enabled. | |
| shared_spaces | boolean | Whether shared spaces are enabled in Team Chat. | |
| show_status_to_internal_contact | boolean | Whether presence status is shown to internal contacts. | |
| security | object | Account security settings including sign-in requirements, password policies, and admin permissions. | |
| delete_pii_from_reports_dashboard | boolean | Whether personally identifiable information (PII) is removed from reports and dashboards. | |
| user_modifiable_info_by_admin | list<string> | List of user profile fields that admins can modify. | |
| import_photos_from_devices | boolean | Whether users can import profile photos from their devices. | |
| licensed_user_modifiable_info_by_admin | list<string> | List of licensed user profile fields that admins can modify. | |
| host_key_length | number | Length of the host key required to claim host role in a meeting. | |
| admin_change_licensed_user_info | boolean | Whether admins can change licensed user information. | |
| sign_in_with_two_factor_auth | string | Two-factor authentication requirement setting (none, all, thirdPartyOnly). | |
| sign_again_period_for_inactivity_on_web | number | Inactivity timeout period (in minutes) for web browser sessions before requiring re-sign-in. 0 means disabled. | |
| admin_change_user_info | boolean | Whether admins can change user information such as display name and profile picture. | |
| hide_billing_info | boolean | Whether billing information is hidden from non-admin users. | |
| signin_with_sso | object | SSO sign-in requirement settings. | |
| enable | boolean | Whether signing in with SSO is required for account users. | |
| admin_change_name_pic | boolean | Whether admins can change user display names and profile pictures. | |
| password_requirement | object | Password complexity requirements for account users. | |
| weak_enhance_detection | boolean | Whether weak password detection is enhanced. | |
| have_special_character | boolean | Whether passwords must contain at least one special character. | |
| consecutive_characters_length | number | Maximum number of consecutive identical characters allowed in passwords. | |
| minimum_password_length | number | Minimum length required for account passwords. | |
| sign_again_period_for_inactivity_on_client | number | Inactivity timeout period (in minutes) for Zoom desktop client sessions before requiring re-sign-in. 0 means disabled. | |
| authentication_options | list<object> | List of authentication profiles available for meetings. | |
| default_option | boolean | Whether this is the default authentication option. | |
| domains | string | Domain restriction for this authentication profile. | |
| visible | boolean | Whether hosts can see this authentication option when scheduling. | |
| id | string | Authentication profile ID. | |
| name | string | Authentication profile name. | |
| type | string | Authentication type for this profile. | |
| meeting_authentication | boolean | Whether only authenticated users can join meetings. | |
| allow_authentication_exception | boolean | Whether exceptions are allowed to meeting authentication requirements. | |
| email_notification | object | Account Settings - Email Notifications. | |
| cloud_recording_available_reminder | boolean | Notify the host when a cloud recording of a meeting is available. | |
| low_host_count_reminder | boolean | Notify administrators when the number of available host licenses is low. | |
| recording_available_reminder_alternative_hosts | boolean | Notify alternative hosts when a cloud recording is available. | |
| recording_available_reminder_schedulers | boolean | Notify meeting schedulers when a cloud recording is available. | |
| 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. | |
| recording | object | Account Settings - Recording. | |
| save_chat_text | boolean | Save the chat text from the meeting. | |
| 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. | |
| archive | object | Recording archiving settings. | |
| enable | boolean | Whether recording archiving is enabled. | |
| settings | object | Archiving configuration settings. | |
| action_when_archive_failed | number | Action to take when archiving fails. | |
| archive_retention | number | Number of days to retain archived recordings. | |
| audio_file | boolean | Whether audio files are included in archives. | |
| cc_transcript_file | boolean | Whether closed caption transcript files are included in archives. | |
| chat_file | boolean | Whether chat files are included in archives. | |
| chat_with_sender_email | boolean | Whether sender email is included in chat archives. | |
| chat_with_direct_message | boolean | Whether direct messages are included in chat archives. | |
| notification_when_archiving_starts | string | Notification setting when archiving starts. | |
| play_voice_prompt_when_archiving_starts | string | Voice prompt setting when archiving starts. | |
| video_file | boolean | Whether video files are included in archives. | |
| type | number | Archive type (1=cloud meetings, 2=cloud webinars, 3=both). | |
| display_participant_name | boolean | Whether participant names are displayed in cloud recordings. | |
| ip_address_access_control | object | IP address restrictions for accessing cloud recordings. | |
| enable | boolean | Whether IP address access control for cloud recordings is enabled. | |
| ip_addresses_or_ranges | string | Allowed IP addresses or ranges for accessing cloud recordings. | |
| record_files_separately | object | Settings for recording different views as separate files. | |
| gallery_view | boolean | Whether gallery view is recorded as a separate file. | |
| shared_screen | boolean | Whether shared screen content is recorded as a separate file. | |
| active_speaker | boolean | Whether active speaker view is recorded as a separate file. | |
| recording_as_on_demand | boolean | Whether cloud recordings are available as on-demand recordings after the meeting ends. | |
| 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. | |
| upload_custom_caption | boolean | Whether hosts can upload custom captions for cloud recordings. | |
| recording_notifications_phone_users | object | Recording consent notification settings for phone users. | |
| multiple_notifications_phone_users | boolean | Whether multiple notifications are sent to phone users when recording starts. | |
| require_press_one_consent_to_record | boolean | Whether phone users must press 1 to consent to being recorded. | |
| durable_meeting_transcript | object | Durable meeting transcript settings for persistent transcript storage. | |
| allow_host_access_meeting_transcript | boolean | Whether meeting hosts can access the meeting transcript. | |
| durable_meeting_transcript | boolean | Whether durable meeting transcripts are enabled. | |
| cloud_recording_download | boolean | Downloading cloud recordings is enabled. | |
| recording_disclaimer | boolean | Show a disclaimer to participants before a recording starts. | |
| optimize_recording_for_3rd_party_video_editor | boolean | Whether recordings are optimized for third-party video editing software. | |
| recording_audio_transcript | boolean | Whether automatic audio transcription is enabled for cloud recordings. | |
| recording_password_requirement | object | Passcode complexity requirements for sharing cloud recordings. | |
| have_letter | boolean | Whether recording share passcode must contain at least one letter. | |
| have_number | boolean | Whether recording share passcode must contain at least one number. | |
| have_special_character | boolean | Whether recording share passcode must contain at least one special character. | |
| length | number | Minimum length of the recording share passcode. | |
| only_allow_numeric | boolean | Whether the recording share passcode must contain only numbers. | |
| viewer_see_transcript | boolean | Whether viewers of cloud recordings can see the audio transcript. | |
| embed_passcode_in_shareable_link | boolean | Whether the passcode is embedded in the shareable cloud recording link. | |
| allow_share | boolean | Whether cloud recordings can be shared. | |
| show_timestamp | boolean | Add a timestamp to the recording. | |
| recording_highlight | boolean | Whether recording highlight feature is enabled. | |
| prevent_host_access_recording | boolean | If the value of this field is set to `true`, meeting hosts cannot view their meetings' cloud recordings. | |
| cloud_recording | boolean | Allow hosts to record and save the meeting in the cloud. | |
| record_audio_file | boolean | Record an only audio file for all participants. | |
| recording_thumbnails | boolean | Whether recording thumbnails are generated. | |
| required_password_for_existing_cloud_recordings | boolean | Whether a passcode is required for all existing shared cloud recordings. | |
| allow_invitees_access_recordings_without_passcode | boolean | Whether meeting invitees can access cloud recordings without a passcode. | |
| recording_notification_for_zoom_client | object | Recording notification settings shown in the Zoom client. | |
| disclaimer_to_participants | string | Disclaimer text shown to participants when recording starts. | |
| play_voice_prompt | string | Voice prompt played when recording starts. | |
| ask_host_to_confirm | boolean | Whether the host is asked to confirm before recording starts. | |
| account_user_access_recording | boolean | Whether users can access their own cloud recordings. | |
| auto_delete_cmr | boolean | Whether cloud recordings are automatically deleted after a set number of days. | |
| auto_delete_cmr_days | number | Number of days after which cloud recordings are automatically deleted. | |
| record_audio_file_each_participant | boolean | Whether a separate audio file is recorded for each participant. | |
| notification_subscription_url_when_recording_available | boolean | Whether a notification is sent via subscription URL when a recording becomes available. | |
| viewer_see_chat | boolean | Whether viewers of cloud recordings can see the meeting chat. | |
| smart_recording | object | AI smart recording feature settings. | |
| create_next_steps | boolean | Whether AI-generated next steps are created from recordings. | |
| create_recording_highlights | boolean | Whether AI-generated recording highlights are created. | |
| create_smart_chapters | boolean | Whether AI-generated smart chapters are created for recordings. | |
| 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. | |
| save_close_caption | boolean | Whether closed captions are saved with cloud recordings. | |
| save_panelist_chat | boolean | Whether panelist chat is saved with webinar recordings. | |
| recording_storage_email_notifications | boolean | Whether email notifications are sent when recording storage is almost full. | |
| local_recording | boolean | Allow hosts and participants to record the meeting to a local file. | |
| record_speaker_view | boolean | Record the active speaker with a shared screen. | |
| cloud_recording_download_host | boolean | Only the host can download cloud recordings. | |
| save_poll_results | boolean | Whether poll results are saved with cloud recordings. | |
| cloud_recording_permanently_deleted | object | Settings for permanent deletion of cloud recordings from trash. | |
| cloud_recording_permanently_deleted_from_trash | boolean | Whether cloud recordings are permanently deleted from trash. | |
| local_recording_options | object | Local recording permissions and options for meeting participants. | |
| internal_meeting_participants | boolean | Whether internal meeting participants can be locally recorded. | |
| save_chat_messages | boolean | Whether chat messages are saved in local recordings. | |
| participants_with_specified_domains_content | string | Comma-separated list of domains for participants with specified domain restrictions. | |
| participants_with_specified_domains | boolean | Whether recording restrictions apply to participants from specified domains. | |
| save_closed_caption | boolean | Whether closed captions are saved in local recordings. | |
| external_auto_approve_requests | boolean | Whether external participant recording requests are auto-approved. | |
| internal_auto_approve_requests | boolean | Whether internal participant recording requests are auto-approved. | |
| external_meeting_participants | boolean | Whether external meeting participants can be locally recorded. | |
| participants_specified_domains_auto_approve_requests | boolean | Whether recording requests from participants with specified domains are auto-approved. | |
| authenticated_view_cloud_recoding | object | Authentication requirements for viewing shared cloud recordings. | |
| default_authenticate_content | string | Default authentication requirement description for viewing cloud recordings. | |
| authenticated_can_view_cloud_recordings | boolean | Whether only authenticated users can view cloud recordings. | |
| allow_share_to_specific_email_out_of_auth | boolean | Whether recordings can be shared with specific emails outside the authentication requirement. | |
| other_options | object | Miscellaneous account-level settings. | |
| display_meetings_scheduled_for_others | boolean | Whether to display meetings scheduled on behalf of others. | |
| show_one_user_meeting_on_dashboard | boolean | Whether single-user meetings are shown on the dashboard. | |
| use_cdn | string | CDN policy for media delivery (none/default/all). | |
| email_in_attendee_report_for_meeting | boolean | Whether attendee email addresses are included in meeting reports. | |
| meeting_qos_and_mos | number | Meeting QoS and MOS score level setting. | |
| webinar_registration_options | object | Webinar registration option settings. | |
| allow_host_to_enable_join_info | boolean | Whether hosts can enable join information for webinar registration. | |
| allow_host_to_enable_social_share_buttons | boolean | Whether hosts can enable social share buttons for webinar registration. | |
| enable_custom_questions | boolean | Whether custom registration questions are enabled for webinars. | |
| allow_auto_active_users | boolean | Whether new users are automatically activated. | |
| allow_users_contact_support_via_chat | boolean | Whether users can contact Zoom support via chat. | |
| allow_users_enter_and_share_pronouns | boolean | Whether users can set and share their pronouns in Zoom. | |
| blur_snapshot | boolean | Whether screenshots are blurred for privacy when switching apps. | |
| profile | object | Account profile settings. | |
| recording_storage_location | object | Recording storage location settings. | |
| allowed_values | list<string> | List of allowed recording storage location values. | |
| value | string | Currently selected recording storage location. | |
| session_security | object | Geographic access control settings for meetings. | |
| approved_or_denied_countries_or_regions | object | Country/region allowlist or blocklist settings for meeting access. | |
| enable | boolean | Whether geographic access control is enabled for meetings. | |
| method | string | Access control method: approve (allowlist) or deny (blocklist). | |
| approved_list | list<string> | List of countries/regions allowed to join meetings. | |
| denied_list | list<string> | List of countries/regions blocked from joining meetings. | |
| zoom_rooms | object | Zoom Rooms physical meeting room settings. | |
| auto_start_stop_scheduled_meetings | boolean | Whether Zoom Rooms automatically start and stop scheduled meetings. | |
| cmr_for_instant_meeting | boolean | Whether cloud recording is enabled for instant meetings in Zoom Rooms. | |
| list_meetings_with_calendar | boolean | Whether calendar-synced meetings are displayed on Zoom Rooms screens. | |
| upcoming_meeting_alert | boolean | Whether an alert is shown before upcoming meetings in Zoom Rooms. | |
| weekly_system_restart | boolean | Whether weekly automatic system restart is enabled for Zoom Rooms. | |
| zr_post_meeting_feedback | boolean | Whether post-meeting feedback is enabled for Zoom Rooms. | |
| force_private_meeting | boolean | Whether all Zoom Rooms meetings are forced to be private. | |
| hide_host_information | boolean | Whether host information is hidden from meeting participants in Zoom Rooms. | |
| start_airplay_manually | boolean | Whether AirPlay must be started manually in Zoom Rooms. | |
| ultrasonic | boolean | Whether ultrasonic device pairing is enabled for Zoom Rooms. | |
| in_session | object | Zoom Sessions (non-meeting) settings. | |
| custom_data_center_regions | boolean | Whether custom data center regions are enabled for Zoom Sessions. | |
| data_center_regions | list<string> | Selected data center regions for Zoom Sessions. | |
| dscp_audio | number | DSCP value for session audio traffic. | |
| dscp_dual | boolean | Whether dual DSCP marking is enabled for sessions. | |
| p2p_connetion | boolean | Whether peer-to-peer connections are enabled for Zoom Sessions. | |
| ports_range | string | Custom port range for session P2P connections. | |
| subsession | boolean | Whether subsessions (breakout rooms equivalent) are enabled for Zoom Sessions. | |
| unchecked_data_center_regions | list<string> | Data center regions explicitly unchecked for Zoom Sessions. | |
| dscp_marking | boolean | Whether DSCP QoS marking is enabled for sessions. | |
| dscp_video | number | DSCP value for session video traffic. | |
| p2p_ports | boolean | Whether custom P2P ports are configured for sessions. | |
| audio_conferencing | object | Audio conferencing settings including dial-in numbers and call-me options. | |
| toll_call | object | Toll call settings. | |
| enable | boolean | Whether toll call is enabled. | |
| numbers | list<object> | List of toll call numbers. | |
| number | string | The dial-in phone number. | |
| code | string | Dial-in number code. | |
| country_code | string | Country code for the number. | |
| country_name | string | Country name for the number. | |
| display_number | string | Display format of the number. | |
| toll_free_and_fee_based_toll_call | object | Toll-free and fee-based toll call settings. | |
| allow_webinar_attendees_dial | boolean | Whether webinar attendees can use toll-free dial-in. | |
| enable | boolean | Whether toll-free and fee-based toll call is enabled. | |
| numbers | list<object> | List of toll-free and fee-based toll call numbers. | |
| code | string | Dial-in number code. | |
| country_code | string | Country code for the number. | |
| country_name | string | Country name for the number. | |
| display_number | string | Display format of the number. | |
| number | string | The dial-in phone number. | |
| call_me_and_invite_by_phone | object | Call-me and invite-by-phone settings. | |
| allow_webinar_attendees_call_me | boolean | Whether webinar attendees can use call-me functionality. | |
| call_out_countries | object | Call-out country configuration. | |
| allowed_countries | list<object> | List of countries allowed for call-out. | |
| code | string | Country code. | |
| name | string | Country name. | |
| selected_countries | list<object> | List of currently selected countries for call-out. | |
| code | string | Country code. | |
| name | string | Country name. | |
| enable | boolean | Whether call-me and invite-by-phone functionality is enabled. | |
| require_press_1_for_call_me | string | Whether pressing 1 is required to accept a call-me invitation. | |
| global_dial_in_countries | object | Global dial-in country configuration. | |
| allowed_countries | list<object> | List of allowed global dial-in countries. | |
| code | string | Country code. | |
| name | string | Country name. | |
| include_toll_free | boolean | Whether toll-free numbers are included. | |
| selected_countries | list<object> | List of selected global dial-in countries. | |
| name | string | Country name. | |
| code | string | Country code. | |
| participant_phone_masking | object | Participant phone number masking settings. | |
| enable | boolean | Whether participant phone number masking is enabled. | |
| masking_type | string | Type of phone masking applied. | |
| personal_audio_conference | boolean | Whether personal audio conference is enabled. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| app_id | string | Unique identifier for the marketplace app | |
| app_name | string | Display name of the marketplace app | |
| app_status | string | Status of the marketplace app | |
| app_usage | number | Usage count of the marketplace app | |
| scopes | list<object> | List of permission scopes granted to the app | |
| scope_name | string | Name of the permission scope | |
| scope_description | string | Description of the permission scope | |
| app_type | string | Type of the marketplace app | |
| app_icon | string | URL of the marketplace app icon | |
| app_developer_type | string | Developer type of the marketplace app | |
| app_directory_url | string | URL to the app in the marketplace directory | |
| approval_info | object | Approval information for the app | |
| approved_type | string | Approval type for the app (e.g., forSpecificUser) | |
| approver_id | string | User ID of the approver | |
| approved_time | number | Timestamp when the app was approved |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| appID | string | The unique identifier of Connected Application | |
| riskLevel | string | The risk level associated with the Connected Application. | |
| permissionsMetadata | list<object> | Metadata for each permission associated with the Connected Application. | |
| name | string | Name of the permission. | |
| riskLevel | string | Risk level of the permission. | |
| firstSeenTime | number | Timestamp when the permission was first seen. | |
| removedTime | number | Timestamp when the permission was removed (0 if not removed). | |
| riskScore | number | Risk score of the permission. Not present when riskLevel is Unknown. | |
| connectedAppName | string | Name of the Connected Application. | |
| riskScore | number | The risk score associated with the Connected Application. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| app_id | string | Unique identifier of the app | |
| app_name | string | Name of the app | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| app_usage | number | Number of users using the app | |
| app_status | string | Status of the app (e.g., PUBLISHED) |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| app_status | string | Status of the app (e.g., PUBLISHED) | |
| app_id | string | Unique identifier of the app | |
| app_name | string | Name of the app | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| app_usage | number | Number of users using the app |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| reviewer_name | string | Name of the reviewer | |
| review_date_time | number | Review date and time | |
| app_name | string | Name of the app | |
| app_usage | number | Number of users using the app | |
| app_status | string | Status of the app (e.g., PUBLISHED) | |
| request_approved_number | number | Number of approved requests | |
| request_declined_number | number | Number of declined requests | |
| latest_request_date_time | number | Latest request date and time | |
| app_id | string | Unique identifier of the app | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| request_id | string | Unique identifier of the request | |
| request_total_number | number | Total number of requests | |
| request_pending_number | number | Number of pending requests |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| app_id | string | Unique identifier of the app | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| app_usage | number | Number of users using the app | |
| app_icon | string | URL of the app icon | |
| app_developer_type | string | Type of developer (e.g., Zoom, Third-Party) | |
| scopes | list<object> | List of OAuth scopes requested by the app | |
| scope_name | string | Name of the permission scope | |
| scope_description | string | Description of the permission scope | |
| app_name | string | Name of the app | |
| app_status | string | Status of the app (e.g., PUBLISHED) | |
| app_directory_url | string | URL to the app in Zoom App Directory | |
| approval_info | object | Approval information for the app | |
| approved_type | string | Type of approval (e.g., forSpecificUser, forAllUser) | |
| approver_id | string | ID of the user who approved the app | |
| approved_time | number | Time when the app was approved |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| latest_request_date_time | number | Latest request date and time | |
| reviewer_name | string | Name of the reviewer | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| app_usage | number | Number of users using the app | |
| app_status | string | Status of the app (e.g., PUBLISHED) | |
| request_id | string | Unique identifier of the request | |
| request_total_number | number | Total number of requests | |
| request_pending_number | number | Number of pending requests | |
| request_declined_number | number | Number of declined requests | |
| review_date_time | number | Review date and time | |
| app_id | string | Unique identifier of the app | |
| app_name | string | Name of the app | |
| request_approved_number | number | Number of approved requests |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| app_help_url | string | URL to the app's help documentation | |
| scopes | list<object> | List of OAuth scopes requested by the app | |
| scope_name | string | Name of the permission scope | |
| scope_description | string | Description of the permission scope | |
| restricted_time | number | Time when the app was restricted | |
| app_id | string | Unique identifier of the app | |
| app_status | string | Status of the app (e.g., PUBLISHED) | |
| app_description | string | Description of the app | |
| app_icon | string | URL of the app icon | |
| app_developer_type | string | Type of developer (e.g., Zoom, Third-Party) | |
| app_name | string | Name of the app | |
| app_type | string | Type of the app (e.g., OAuthApp) | |
| app_usage | number | Number of users using the app | |
| app_privacy_policy_url | string | URL to the app's privacy policy | |
| app_directory_url | string | URL to the app in Zoom App Directory |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| meeting_security | object | Meeting Security Settings | |
| phone_password | boolean | Require a passcode for participants joining by phone. | |
| block_user_domain | boolean | Whether to block users from joining meetings from specified domains. | |
| 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. | |
| waiting_room_settings | object | Specify the settings to be applied if the Waiting Room feature is enabled. | |
| whitelisted_domains_for_waiting_room | string | Domains whose users can bypass the waiting room. | |
| 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. | |
| users_who_can_admit_participants_from_waiting_room | number | Who can admit participants from the waiting room (0=host only, 1=host and co-hosts). | |
| meeting_password | boolean | Whether all meetings require a password. | |
| only_authenticated_can_join_from_webclient | boolean | Whether users joining from the web client must be authenticated. | |
| waiting_room_options | object | Extended waiting room configuration options. | |
| enable | boolean | Whether the waiting room is enabled. | |
| internal_user_auto_admit | number | Auto-admit setting for internal users. | |
| locked | boolean | Whether the waiting room setting is locked by admin. | |
| more_options | object | Additional waiting room options. | |
| allow_participants_to_reply_to_host | boolean | Whether participants in the waiting room can reply to the host. | |
| move_participants_to_waiting_room_when_host_dropped | boolean | Whether to move participants to waiting room when host drops. | |
| user_invited_by_host_can_bypass_waiting_room | boolean | Whether users explicitly invited by the host can bypass the waiting room. | |
| sort_order_of_people | number | Sort order of participants displayed in the waiting room. | |
| who_can_admit_participants | number | Who can admit participants from the waiting room. | |
| admit_domain_allowlist | string | Domains whose users can bypass the waiting room automatically. | |
| admit_type | number | Who can admit participants (0=host only, 1=host and co-hosts). | |
| webinar_password | boolean | Whether webinars require a password. | |
| waiting_room | boolean | When participants join a meeting, place them in a waiting room and require the host to admit them individually. | |
| auto_security | boolean | Whether all meetings must use at least one security option (password, waiting room, or authenticated users only). | |
| block_user_domain_list | list<string> | List of domains blocked from joining meetings. | |
| chat_etiquette_tool | object | Chat etiquette tool settings for meeting security. | |
| enable | boolean | Whether the chat etiquette/keyword filtering tool is enabled for meetings. | |
| policies | list<object> | List of chat etiquette policies. | |
| id | string | Policy ID. | |
| is_locked | boolean | Whether the policy is locked. | |
| keywords | list<string> | Keywords monitored by this policy. | |
| name | string | Policy name. | |
| regular_expression | string | Regular expression pattern for keyword matching. | |
| status | string | Policy status (active/inactive). | |
| trigger_action | number | Action to take when policy is triggered. | |
| description | string | Policy description. | |
| policy_max_count | number | Maximum number of chat etiquette policies allowed. | |
| encryption_type | string | Meeting encryption type: enhanced_encryption or e2ee (end-to-end encryption). | |
| require_password_for_scheduled_meeting | boolean | Whether scheduled meetings require a password. | |
| require_password_for_scheduled_webinar | boolean | Whether scheduled webinars require a password. | |
| meeting_password_requirement | object | Meeting password requirements | |
| 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. | |
| 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. | |
| end_to_end_encrypted_meetings | boolean | Whether end-to-end encryption is available for meetings. | |
| pmi_password | boolean | Whether Personal Meeting ID (PMI) meetings require a password. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| signin_with_sso | object | SSO sign-in configuration settings. | |
| enable | boolean | Whether SSO sign-in is enabled for the account. | |
| domains | list<string> | Domains for which SSO sign-in is configured or enforced. | |
| require_sso_for_domains | boolean | Whether SSO is mandatory for users in the configured domains. | |
| sso_bypass_users | list<object> | Users who are exempt from mandatory SSO sign-in. | |
| string | Email address of the user exempt from mandatory SSO. | ||
| id | string | User ID of the user exempt from mandatory SSO. | |
| admin_change_user_info | boolean | Only account administrators can change a user's information. | |
| 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. | |
| sign_again_period_for_inactivity_on_client | number | Session inactivity timeout in minutes for the Zoom desktop client. | |
| sign_again_period_for_inactivity_on_web | number | Session inactivity timeout in minutes for the Zoom web portal. | |
| 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_name_pic | boolean | Whether only admins can change users' display names and profile pictures. | |
| sign_in_with_two_factor_auth | string | Two-factor authentication enforcement mode: all (all users), none, or specific groups/roles. | |
| sign_in_with_two_factor_auth_groups | list<string> | Group IDs required to use two-factor authentication. | |
| sign_in_with_two_factor_auth_roles | list<string> | Role IDs required to use two-factor authentication. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| login_types | list<number> | The user's login method | |
| telephony | object | User settings: Meeting settings | |
| audio_conference_info | string | Third party audio conference info | |
| show_international_numbers_link | boolean | Show the international numbers link on the invitation email | |
| telephony_regions | object | Indicates where most of the participants call into or call from during a meeting | |
| selection_values | list<string> | The selected telephony regions as a list | |
| allowed_values | list<string> | Telephony region options provided by Zoom to select from | |
| selection_value | string | The account's selected telephony regions that indicate where most participants call into or call from during a meeting | |
| third_party_audio | boolean | Third party audio conference | |
| account_number | number | The user's account number | |
| cluster | string | The user's cluster | |
| group_ids | list<string> | IDs of the web groups user belongs to. | |
| im_group_ids | list<string> | IM IDs of the groups user belongs to | |
| cms_user_id | string | CMS ID of user, only enabled for Kaltura integration | |
| id | string | User ID | |
| language | string | Default language for the Zoom Web Portal | |
| last_client_version | string | User last login client version | |
| recording | object | User settings: Recording settings | |
| ask_host_to_confirm_disclaimer | boolean | Whether the host is asked to confirm before a recording starts. | |
| optimize_recording_for_3rd_party_video_editor | boolean | Whether recordings are optimized for third-party video editing. | |
| record_speaker_view | boolean | Whether active speaker view is included in cloud recordings. | |
| recording_audio_transcript | boolean | Whether automatic audio transcription is enabled for the user's cloud recordings. | |
| save_close_caption | boolean | Whether closed captions are saved with the user's cloud recordings. | |
| save_panelist_chat | boolean | Whether panelist chat is saved with the user's webinar recordings. | |
| show_timestamp | boolean | Whether a timestamp is shown on the user's cloud recordings. | |
| smart_recording | object | AI smart recording feature settings for the user. | |
| create_smart_chapters | boolean | Whether AI-generated smart chapters are created. | |
| create_next_steps | boolean | Whether AI-generated next steps are created from the user's recordings. | |
| create_recording_highlights | boolean | Whether AI-generated recording highlights are created. | |
| auto_delete_cmr | boolean | Auto delete cloud recordings | |
| auto_recording | string | Automatic recording | |
| recording_disclaimer | boolean | Show a disclaimer to participants before a recording starts | |
| recording_password_requirement | object | recording_password_requirement | |
| have_letter | boolean | Passcode must contain at least one alphabetical letter (a, b, c..) | |
| have_number | boolean | Passcode must contain at least one number(1, 2, 3..) | |
| have_special_character | boolean | Passcode must contain at least one special character(!, @, #..) | |
| length | number | Minimum required length for the passcode | |
| only_allow_numeric | boolean | Passcode must contain only numeric characters | |
| auto_delete_cmr_days | number | Number of days after which the user's cloud recordings are automatically deleted. | |
| record_files_separately | object | Settings for recording different views as separate files. | |
| shared_screen | boolean | Whether shared screen content is recorded as a separate file. | |
| active_speaker | boolean | Whether active speaker view is recorded as a separate file. | |
| gallery_view | boolean | Whether gallery view is recorded as a separate file. | |
| record_gallery_view | boolean | Whether gallery view is included in cloud recordings. | |
| recording_highlight | boolean | Whether recording highlights are enabled for the user. | |
| local_recording | boolean | Local recording | |
| host_pause_stop_recording | boolean | Whether the host can pause or stop cloud recording. | |
| record_audio_file | boolean | Whether an audio-only recording file is created. | |
| recording_thumbnails | boolean | Whether recording thumbnails are generated for the user. | |
| ip_address_access_control | object | Setting to allow cloud recording access only from specific IP address ranges | |
| enable | boolean | If set to true, the cloud recordings of this account can only be accessed by the IP addresses defined in the ip_addresses_or_ranges property | |
| ip_addresses_or_ranges | string | IP addresses or ranges that have access to the cloud recordings. | |
| ask_participants_to_consent_disclaimer | boolean | Whether participants are asked to consent to recording. | |
| cloud_recording | boolean | Whether the user can record and save meetings in the cloud. | |
| display_participant_name | boolean | Whether participant names are displayed in the user's cloud recordings. | |
| recording_notification_for_zoom_client | object | Recording notification settings in the Zoom client. | |
| ask_host_to_confirm | boolean | Whether the host is asked to confirm when recording starts. | |
| disclaimer_to_participants | string | Disclaimer shown to participants when recording starts. | |
| play_voice_prompt | string | Voice prompt played when recording starts. | |
| save_chat_text | boolean | Whether chat text is saved with the user's cloud recordings. | |
| save_poll_results | boolean | Whether poll results are saved with the user's cloud recordings. | |
| created_at | number | The date and time at which this user's latest login type was created. | |
| profile | object | Profile | |
| recording_storage_location | object | recording_storage_location | |
| value | string | Abbreviated country code | |
| allowed_values | list<string> | Users can choose the country to store their recorded content | |
| verified | number | Whether Zoom has verified the phone number | |
| account_id | string | User's account ID | |
| dept | string | Department | |
| string | User's email address | ||
| in_meeting | object | User settings: Meeting settings | |
| co_host | boolean | Allow the host to add co-hosts | |
| custom_live_streaming_service | boolean | Whether to allow custom live streaming. | |
| e2e_encryption | boolean | Zoom requires encryption for all data between the Zoom cloud, Zoom client, and Zoom Room. Require encryption for 3rd party endpoints (H323/SIP) | |
| webinar_ai_companion_questions | boolean | Whether AI Companion questions are enabled for webinars | |
| p2p_ports | boolean | Whether to use custom peer-to-peer ports | |
| attendee_on_hold | boolean | Allow host to put attendee on hold | |
| closed_caption | boolean | Enable closed captions | |
| custom_data_center_regions | boolean | If set to true, you can select data center regions to use for hosting your real-time meeting and webinar traffic. These regions can be provided in the data_center_regions field. If set to false, the regions cannot be customized and the default regions will be used. | |
| remote_control | boolean | Enable remote control during screensharing | |
| show_meeting_control_toolbar | boolean | Always show meeting controls during a meeting | |
| webinar_polling | object | Information about the user's webinar polling settings | |
| enable | boolean | Allow the host to add polls before or during a webinar | |
| ports_range | string | The range of peer-to-peer ports to use | |
| allow_participants_chat_with | number | Specify who participants can chat with | |
| language_interpretation | object | Information about the language interpretation settings | |
| enable | boolean | Allow hosts to assign participants as interpreters who can interpret one language into another in real-time | |
| webinar_chat | object | webinar_chat | |
| allow_attendees_chat_with | number | Allow webinar attendees to chat with | |
| allow_auto_save_local_chat_file | boolean | Automatically save chat messages to a local file on the host's computer when the webinar ends. | |
| allow_panelists_chat_with | number | Who webinar panelists can chat with | |
| allow_panelists_send_direct_message | boolean | Allow webinar panelists to send direct messages to other panelists. | |
| allow_users_save_chats | number | How webinar attendees can save chats | |
| default_attendees_chat_with | number | By default, allow webinar attendees to chat with | |
| enable | boolean | Allow webinar participants to send chat messages | |
| allow_host_to_enable_focus_mode | boolean | Whether hosts can enable Focus Mode when starting a meeting | |
| anonymous_question_answer | boolean | Allow anonymous Q&A in webinar | |
| virtual_background_settings | object | virtual_background_settings | |
| allow_upload_custom | boolean | Allow user to upload custom backgrounds | |
| allow_videos | boolean | Allow use of videos for virtual backgrounds | |
| enable | boolean | Enable virtual background | |
| files | list<object> | files | |
| is_default | boolean | Indicates whether or not this file is the default virtual background file | |
| name | string | File name | |
| type | string | File type | |
| allow_live_streaming | boolean | Whether to allow live streaming | |
| allow_show_zoom_windows | boolean | Enable the Show Zoom windows during screen share feature | |
| allow_users_to_delete_messages_in_meeting_chat | boolean | If the value of this field is set to true, allow users to delete messages in the in-meeting chat | |
| live_streaming_youtube | boolean | Whether to allow YouTube live streaming | |
| allow_users_save_chats | number | Specify how participants can save meeting chats | |
| attention_mode_focus_mode | boolean | Whether the Focus Mode feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting | |
| unchecked_data_center_regions | list<string> | f the value of custom_data_center_regions is true, a comma-separated list of the data center regions to not opt in to | |
| file_transfer | boolean | Indicates whether in-meeting file transfer setting has been enabled for the user or not | |
| meeting_reactions | boolean | Allow meeting participants to communicate using the emoji reactions located in the Reactions menu in the meeting toolbar | |
| slide_control | boolean | Allow the person sharing during a presentation to allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher | |
| meeting_survey | boolean | Whether to allow the host to add a survey that will be displayed to participants after the meeting ends | |
| dscp_audio | number | The DSCP value for audio | |
| sign_language_interpretation | object | Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later | |
| enable | boolean | Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time | |
| dscp_dual | number | The DSCP value for dual streams | |
| webinar_question_answer | boolean | Enable Q&A for webinars | |
| webinar_survey | boolean | Enable the ability for the host to add a post webinar survey | |
| non_verbal_feedback | boolean | Enable non-verbal feedback through screens | |
| remote_support | boolean | Allow host to provide 1:1 remote support to a participant | |
| waiting_room | boolean | Enable Waiting room - if enabled, attendees can only join after host approves | |
| webinar_summary_with_ai_companion | boolean | Whether AI Companion meeting summary is enabled for webinars | |
| ai_companion_questions | object | Whether AI Companion question answering is enabled for meetings | |
| auto_enable | boolean | Whether AI Companion Q&A is automatically enabled for meetings. | |
| enable | boolean | Whether AI Companion Q&A feature is enabled. | |
| who_can_ask_questions | number | Who can ask questions using AI Companion (0=all, 1=host/co-host only). | |
| original_audio | boolean | Whether participants can turn off the high-fidelity, professional audio processing | |
| data_center_regions | list<string> | If the value of custom_data_center_regions is true, a comma-separated list of the data center regions to opt in to | |
| allow_participants_to_rename | boolean | allow_participants_to_rename | |
| manual_captioning | object | Information about manual captioning settings | |
| manual_captions | boolean | Enable manual closed captioning | |
| save_captions | boolean | Allow participants to save closed captions or transcripts | |
| third_party_captioning_service | boolean | Allow the use of an API token to integrate with a 3rd-party device to provide closed captioning | |
| allow_to_type | boolean | Allow the host to manually caption or let the host assign a participant to provide manual captioning | |
| auto_generated_captions | boolean | Enable Zoom's live transcription feature | |
| full_transcript | boolean | Enable the viewing of full transcripts in the in-meeting side panel | |
| record_play_voice | boolean | Record and play their own voice | |
| transfer_meetings_between_devices | boolean | Users can move to a new device without leaving the meeting they're in | |
| who_can_share_screen_when_someone_is_sharing | string | Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. | |
| auto_answer | boolean | auto_answer | |
| group_hd | boolean | Enable group HD video | |
| private_chat | boolean | Enable 1:1 private chat between participants during meetings | |
| screen_sharing | boolean | Allow host and participants to share their screen or content during meetings | |
| show_a_join_from_your_browser_link | boolean | 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. | |
| workplace_by_facebook | boolean | Whether to allow Workplace by Facebook live streaming | |
| webinar_reactions | boolean | Whether to allow webinar attendees to use emoji reactions | |
| meeting_summary_with_ai_companion | object | Whether the AI Companion meeting summary feature is enabled for meetings | |
| who_will_receive_summary | number | Who receives the AI-generated meeting summary (0=host only, 1=all participants). | |
| auto_enable | boolean | Whether AI meeting summary is automatically enabled. | |
| enable | boolean | Whether AI meeting summary feature is enabled. | |
| breakout_room | boolean | Allow host to split meeting participants into separate breakout rooms | |
| disable_screen_sharing_for_host_meetings | boolean | Enable the Disable desktop screen sharing for meetings you host setting. | |
| stereo_audio | boolean | Whether participants can use stereo audio | |
| participants_share_simultaneously | string | Indicates how many participants can share at the same time | |
| participants_to_place_in_waiting_room | number | The type of participants to be admitted to the Waiting Room | |
| virtual_background | boolean | Enable virtual background | |
| feedback | boolean | Enable option to send feedback to Zoom at the end of the meeting | |
| annotation | boolean | Allow participants to use annotation tools | |
| closed_captioning | object | Information about the user's closed captioning settings | |
| auto_transcribing | boolean | Whether to allow a live transcription service to transcribe meetings | |
| enable | boolean | Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning | |
| save_caption | boolean | Whether to allow participants to save closed captions or transcripts | |
| third_party_captioning_service | boolean | Whether to allow the use of an API token to integrate with 3rd-party closed captioning services | |
| view_full_transcript | boolean | Whether to allow the viewing of full transcripts in the in-meeting side panel | |
| far_end_camera_control | boolean | Allow another user to take control of the camera | |
| meeting_polling | object | Information about the account's meeting polling settings | |
| enable | boolean | Whether to allow the host to add polls before or during a meeting | |
| join_from_desktop | boolean | Allow participants to join a meeting directly from their desktop browser | |
| live_streaming_facebook | boolean | Whether to allow Facebook live streaming | |
| whiteboard | boolean | Whether to enable the Zoom Whiteboard feature. | |
| who_can_share_screen | string | Indicates who can share their screen or content during meetings | |
| share_dual_camera | boolean | Whether to allow participants to share a second camera in a meeting | |
| allow_host_panelists_to_use_audible_clap | boolean | Whether to allow the host and panelists to use the audible clap feature | |
| dscp_video | number | The DSCP value for video | |
| chat | boolean | Enable chat during meeting for all participants | |
| meeting_question_answer | boolean | Allow participants to ask questions for the host and participants to answer | |
| post_meeting_feedback | boolean | Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting | |
| polling | boolean | Enable meeting polling | |
| breakout_room_schedule | boolean | Whether the host can assign participants to breakout rooms when scheduling. This feature is only available in version 4.5.0 or higher. | |
| entry_exit_chime | string | Play sound when participants join or leave | |
| webinar_live_streaming | object | webinar_live_streaming | |
| live_streaming_reminder | number | Whether to notify users to watch the live stream. This does not apply to custom RTMP (real-time messaging protocol) | |
| live_streaming_service | boolean | The available live streaming services | |
| custom_service_instructions | string | The specific instructions to allow your account's meeting hosts to configure a custom live stream. | |
| enable | boolean | Whether webinar live streaming is enabled. | |
| meeting_reactions_emojis | string | The type of emoji reactions that meeting participants can use. all: All emojis. selected: Selected emojis. | |
| auto_saving_chat | boolean | Auto save all in-meeting chats | |
| disable_screen_sharing_for_in_meeting_guests | boolean | Enable the Disable screen sharing when guests are in the meeting setting | |
| join_from_mobile | boolean | Allow participants to join a meeting directly from their mobile browser | |
| request_permission_to_unmute_participants | boolean | Indicates whether the Request permission to unmute participants option has been enabled for the user or not | |
| webinar_group_hd | boolean | Whether to allow the host to enable HD video for webinar panelists | |
| dscp_marking | boolean | Whether DSCP marking is enabled | |
| integration | object | integration | |
| linkedin_sales_navigator | boolean | linkedin_sales_navigator | |
| location | string | User's location | |
| timezone | string | The time zone of the user | |
| use_pmi | boolean | Displays true if user has enabled a Personal Meeting ID (PMI) for instant meetings, false otherwise | |
| role_id | string | Unique identifier of the role assigned to the user | |
| audio_conferencing | object | The user's audio conference settings. | |
| personal_audio_conference | object | Personal Audio Conference settings | |
| enable | boolean | Whether Personal Audio Conference is enabled | |
| toll_call | object | Toll call settings for audio conferencing | |
| enable | boolean | Whether toll calling is enabled | |
| toll_free_and_fee_based_toll_call | object | The user's Toll-free and Fee-based Toll Call settings | |
| enable | boolean | Whether the user has the Toll-free and Fee-based Toll Call setting enabled. | |
| numbers | list<object> | List of toll-free and fee-based toll call numbers | |
| code | string | Country code | |
| country_code | string | Two-letter country code | |
| country_name | string | Country name | |
| display_number | string | Display number | |
| number | string | Phone number | |
| allow_webinar_attendees_dial | boolean | Whether webinar attendees can dial in | |
| call_me_and_invite_by_phone | object | Call Me and Invite by Phone settings for audio conferencing | |
| allow_call_out | boolean | Whether call-out is allowed | |
| allow_call_out_countries | list<string> | Countries for which call-out is allowed | |
| enable | boolean | Whether Call Me and Invite by Phone is enabled | |
| global_dial_in_countries | list<object> | Global dial-in countries for audio conferencing | |
| number | string | Dial-in number | |
| type | string | Dial-in number type (toll or toll-free) | |
| country_code | string | Country code | |
| country_name | string | Country name | |
| participant_phone_masking | object | Whether participant phone numbers are masked in the meeting | |
| enable | boolean | Whether phone number masking for participants is enabled | |
| email_notification | object | User settings: Notification settings | |
| cancel_meeting_reminder | boolean | When a meeting is cancelled | |
| jbh_reminder | boolean | When attendees join meeting before host | |
| alternative_host_reminder | boolean | When an alternative host is set or removed from a meeting | |
| cloud_recording_available_reminder | boolean | Whether to notify the host when a cloud recording is available | |
| recording_available_reminder_alternative_hosts | boolean | Whether to notify any alternative hosts when a cloud recording is available | |
| recording_available_reminder_schedulers | boolean | Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available | |
| schedule_for_reminder | boolean | Notify the host there is a meeting is scheduled, rescheduled, or cancelled | |
| jid | string | jid | |
| personal_meeting_url | string | User's personal meeting url | |
| schedule_meeting | object | User settings: Meeting settings | |
| require_password_for_instant_meetings | boolean | Require a passcode for instant meetings. If you use PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts | |
| pmi_password | string | The password for PMI meetings | |
| host_video | boolean | Start meetings with host video on | |
| join_before_host | boolean | Join the meeting before host arrives | |
| meeting_password_requirement | object | Account wide meeting or webinar passcode requirements | |
| have_upper_and_lower_characters | boolean | Passcode must include both uppercase and lowercase characters. | |
| length | number | The minimum length that the meeting/webinar passcode must have | |
| only_allow_numeric | boolean | Passcode must only contain numbers and no other characters | |
| weak_enhance_detection | boolean | Inform users if the provided passcode is weak | |
| consecutive_characters_length | number | consecutive_characters_length | |
| have_letter | boolean | Passcode must contain at least 1 letter (such as a,b,c...) | |
| have_number | boolean | Passcode must contain at least 1 number (such as 1,2,3...) | |
| have_special_character | boolean | Passcode must have at least 1 special character (!,@,#...) | |
| require_password_for_scheduling_new_meetings | boolean | Require a passcode when scheduling new meetings.This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts | |
| require_password_for_scheduled_meetings | string | Require a passcode for meetings which have already been scheduled | |
| audio_type | string | Determine how participants can join the audio portion of the meeting | |
| enable_dedicated_group_chat | boolean | enable_dedicated_group_chat | |
| force_pmi_jbh_password | boolean | Require a passcode for personal meetings if attendees can join before host | |
| mute_upon_entry | boolean | mute_upon_entry | |
| personal_meeting | boolean | Personal Meeting Setting | |
| pstn_password_protected | boolean | Generate and require passcode for participants joining by phone | |
| use_pmi_for_instant_meetings | boolean | Use a Personal Meeting ID (PMI) when starting an instant meeting | |
| use_pmi_for_scheduled_meetings | boolean | Use a Personal Meeting ID (PMI) when scheduling a meeting | |
| embed_password_in_join_link | boolean | Encrypt the meeting passcode and include it in the join meeting link to allow participants to join with just one click without having to enter the passcode | |
| participants_video | boolean | Start meetings with participants video on | |
| require_password_for_pmi_meetings | string | Require a passcode for Personal Meeting ID (PMI). This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts | |
| default_password_for_scheduled_meetings | string | The default password for scheduled meetings | |
| continuous_meeting_chat | object | Continuous meeting chat settings | |
| can_set_default_auto_add_contact | boolean | Whether the user can set contacts to automatically add to meeting chats | |
| auto_add_invited_external_users | boolean | Whether to auto-add invited external users to the meeting chat | |
| enable | boolean | Whether continuous meeting chat is enabled | |
| tsp | object | tsp | |
| call_out | boolean | call_out | |
| show_international_numbers_link | boolean | Show the international numbers link on the invitation email. | |
| call_out_countries | list<string> | List of countries available for call-out | |
| global_dial_in_countries | list<object> | Global dial-in country settings | |
| country_name | string | Country name | |
| number | string | Dial-in number | |
| type | string | Dial-in type (toll or toll-free) | |
| country_code | string | Country code | |
| meeting_security | object | meeting_security | |
| block_user_domain | boolean | Whether users in specific domains are blocked from joining meetings and webinars | |
| end_to_end_encrypted_meetings | boolean | Whether end-to-end encryption is enabled for meetings | |
| meeting_password | boolean | Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. Personal Meeting ID (PMI) meetings are not included in this setting. | |
| meeting_password_requirement | object | meeting_password_requirement | |
| have_number | boolean | Passcode must contain at least 1 number (such as 1,2,3...). | |
| have_special_character | boolean | Passcode must have at least 1 special character (!,@,#...). | |
| have_upper_and_lower_characters | boolean | Passcode must include both uppercase and lowercase characters. | |
| length | number | The minimum length that the meeting/webinar passcode must have. | |
| only_allow_numeric | boolean | Passcode must only contain numbers and no other characters. | |
| weak_enhance_detection | boolean | Inform users if the provided passcode is weak. | |
| consecutive_characters_length | number | Allowed: 0|4|5|6|7|8 | |
| have_letter | boolean | Passcode must contain at least 1 letter (such as a,b,c...). | |
| webinar_password | boolean | Whether the user's webinars require a password. | |
| block_user_domain_list | list<string> | List of domains blocked from joining the user's meetings. | |
| approved_or_denied_countries_or_regions | object | approved_or_denied_countries_or_regions | |
| enable | boolean | enable | |
| embed_password_in_join_link | boolean | Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password | |
| only_authenticated_can_join_from_webclient | boolean | Whether to specify that only authenticated users can join the meeting from the web client. | |
| waiting_room_settings | object | Information about the Waiting Room settings | |
| participants_to_place_in_waiting_room | number | The type of participants to be admitted to the Waiting Room | |
| users_who_can_admit_participants_from_waiting_room | number | Who can admit participants from the waiting room (0=host only, 1=host and co-hosts). | |
| whitelisted_domains_for_waiting_room | string | Domains whose users can bypass the waiting room. | |
| require_password_for_scheduled_webinar | boolean | Whether the user's scheduled webinars require a password. | |
| require_password_for_scheduled_meeting | boolean | Whether passwords are required for meetings that have already been scheduled. | |
| pmi_password | boolean | Whether the user's Personal Meeting ID (PMI) meetings require a password. | |
| auto_security | boolean | Whether all meetings must be secured with at least one security option | |
| encryption_type | string | The type of encryption used when starting a meeting | |
| phone_password | boolean | Whether passwords are required for participants joining by phone. | |
| waiting_room | boolean | Whether participants are placed in the Waiting Room when they join a meeting. | |
| job_title | string | User's job title | |
| pmi | number | Personal Meeting ID (PMI). | |
| role_name | string | User's role name | |
| status | string | Status of user's account | |
| allow_authentication_exception | boolean | Whether the Allow authentication exception setting is enabled. This lets hosts invite users who can bypass authentication | |
| meeting_authentication | boolean | Only authenticated users can join meetings | |
| recording_authentication | boolean | Only authenticated users can view cloud recordings | |
| last_login_time | number | User last login time. | |
| type | number | User's plan type | |
| user_created_at | number | The date and time at which this user was created. | |
| authentication_options | list<object> | Meeting Authentication Options | |
| domains | string | Domain restriction for this authentication profile. | |
| meeting_authentication | object | User-level meeting authentication settings object. | |
| authentication_options | list<object> | List of authentication profiles for meetings. | |
| id | string | Authentication profile ID. | |
| name | string | Authentication profile name. | |
| type | string | Authentication type. | |
| visible | boolean | Whether this option is visible to hosts. | |
| default_option | boolean | Whether this is the default authentication option. | |
| domains | string | Domain restriction for this authentication profile. | |
| meeting_authentication | boolean | Whether only authenticated users can join meetings. | |
| allow_authentication_exception | boolean | Whether exceptions are allowed to meeting authentication. | |
| recording_authentication | object | User-level recording authentication settings object. | |
| authentication_options | list<object> | List of authentication profiles for recordings. | |
| id | string | Profile ID. | |
| name | string | Profile name. | |
| type | string | Authentication type. | |
| visible | boolean | Whether visible to hosts. | |
| default_option | boolean | Whether this is the default option. | |
| domains | string | Domain restriction. | |
| recording_authentication | boolean | Whether only authenticated users can view recordings. | |
| default_option | boolean | Authentication default option | |
| id | string | Authentication id | |
| name | string | Authentication name | |
| type | string | Authentication type. | |
| visible | boolean | Authentication visible | |
| general_setting | object | General user-level settings. | |
| auto_zoom_room_proximity_connect | boolean | Whether Zoom Rooms automatically connect via proximity detection. | |
| feature | object | User settings: Feature settings | |
| cn_meeting | boolean | Host meeting in China | |
| meeting_capacity | number | User's meeting capacity | |
| webinar | boolean | Webinar feature | |
| webinar_capacity | number | Webinar capacity: can be 100, 500, 1000, 3000, 5000 or 10000, depending on if the user has a webinar capacity plan subscription or not | |
| zoom_customer_managed_key | boolean | Whether the user has a Zoom Customer Managed Key license | |
| zoom_iq_for_sales | boolean | Whether the user has a Zoom IQ license | |
| zoom_whiteboard_plus | boolean | Whether the user has a Zoom Whiteboard Plus license | |
| zoom_workforce_management | boolean | zoom_workforce_management | |
| license_info_list | list<string> | List of user's license information | |
| large_meeting | boolean | Large meeting feature | |
| large_meeting_capacity | number | Large meeting capacity: can be 500 or 1000, depending on if the user has a large meeting capacity plan subscription or not | |
| zoom_events_unlimited | boolean | zoom_events_unlimited | |
| zoom_whiteboard | boolean | Whether the user has a Zoom Whiteboard license | |
| concurrent_meeting | string | The user's concurrent meeting plan type. Basic: basic plan. Plus: plus plan. None: no plan. | |
| zoom_docs | boolean | Whether the user has a Zoom Docs license | |
| zoom_events_capacity | number | The capacity for Zoom Events | |
| in_meeting | boolean | Host meeting in India | |
| zoom_clips_plus | boolean | Whether the user has a Zoom Clips Plus plan | |
| zoom_scheduler | boolean | Whether the user has the Zoom Scheduler feature | |
| zoom_mail_calendar | boolean | Whether the user has the Zoom Mail and Calendar feature | |
| zoom_compliance_management | boolean | Whether the user has a Zoom Compliance Management license | |
| zoom_events | boolean | Whether the Zoom Events feature is enabled for the user | |
| zoom_events_consumption | string | zoom_events_consumption | |
| zoom_events_pay_per_attendee | boolean | zoom_events_pay_per_attendee | |
| zoom_huddles | boolean | zoom_huddles | |
| zoom_translated_captions | boolean | Whether the user has a Zoom Translated Captions license | |
| zoom_webinars_capacity | number | The capacity for Zoom Webinars | |
| zoom_events_saas | boolean | zoom_events_saas | |
| zoom_sessions_pay_per_attendee | boolean | zoom_sessions_pay_per_attendee | |
| zoom_sessions_unlimited | boolean | zoom_sessions_unlimited | |
| zoom_webinars | boolean | Whether the user has the Zoom Webinars feature enabled | |
| zoom_revenue_accelerator | boolean | Whether the user has a Zoom Revenue Accelerator license | |
| zoom_phone | boolean | Zoom phone feature | |
| zoom_quality_management | boolean | zoom_quality_management |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|