Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    Update Account Settings

    Use this API to update an account's settings. To update the Master account's settings, pass the me value for the accountId path parameter.

    Scopes: account:write:admin
    Rate Limit Label: Medium

    Prerequisites:

    • The account must be a paid account.

    Input

    type: object properties: parameters: type: object properties: accountId: type: string example: me description: >- The account's ID. For the Master account, pass the `me` value for this parameter. option: enum: - meeting_authentication - recording_authentication - security - meeting_security type: string example: meeting_security description: >- Optional query parameters: * `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. * `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. * `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account. required: - accountId title: Parameters data: oneOf: - properties: security: description: >- [Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account. type: object properties: admin_change_name_pic: type: boolean deprecated: true description: >- Whether to only allow account administrators to change a user's picture. example: true admin_change_user_info: type: boolean description: >- Whether to only allow account administrators to change a user's information. example: true user_modifiable_info_by_admin: type: array description: >- If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify: * `name` * `profile_picture` * `sign_in_email` * `host_key` items: type: string enum: - name - profile_picture - sign_in_email - host_key example: - name - host_key - sign_in_email signin_with_sso: type: object description: 'Allow users to sign in with single sign-on (SSO). ' properties: enable: description: >- Whether to allow users to sign in with ssingle sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users to sign in with SSO through your company's vanity URL. type: boolean example: true require_sso_for_domains: description: >- Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`. type: boolean example: true domains: type: array description: >- Users on these domains are required to sign in with single sign-on (SSO). example: - test.com - example.us items: type: string example: test.com sso_bypass_user_ids: type: array description: The users' ID can bypass SSO sign-in. items: type: string example: 1211414124112zw_r hide_billing_info: description: Hide billing information. type: boolean example: true import_photos_from_devices: description: >- Allow users to import photos from a photo library on a device. type: boolean example: true password_requirement: description: >- This object refers to the [enhanced password rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login password. type: object properties: consecutive_characters_length: description: >- Specify the max length of consecutive characters(abcde...) that can be used in a password. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password. The max allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh). type: integer example: 8 have_special_character: description: >- If the value of this field is set to `true`, the password must have at least one special character(!, @, #...). type: boolean example: true minimum_password_length: description: >- Specify a minimum length for the password. The password length can be from a minimum of 9 characters, up to 14 characters. If you provide `0` as the value of this field, this field will be disabled and not be used and the basic password length requirement (minimum of 8 characters) will be applied for the requirement. maximum: 14 minimum: 8 type: integer example: 8 weak_enhance_detection: description: >- If the value of this field is set to `true`, user passwords will have to pass detection through a weak password dictionary in case hackers use simple passwords to sign in to your users' accounts. type: boolean example: true sign_again_period_for_inactivity_on_client: description: > Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Client app after a set amount of time. <br> If this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Client. The value for the period of inactivity can be one of the following:<br> `5`: 5 minutes<br> `10`: 10 minutes<br> `15`: 15 minutes<br> `30`: 30 minutes<br> `45`: 45 minutes<br> `60`: 60 minutes<br> `90`: 90 minutes<br> `120`: 120 minutes type: integer example: 45 sign_again_period_for_inactivity_on_web: description: >+ Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Web Portal after a set amount of time. <br> If this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Web Portal. The value for the period of inactivity can be one of the following:<br> `5`: 5 minutes<br> `10`: 10 minutes<br> `15`: 15 minutes<br> `30`: 30 minutes<br> `60`: 60 minutes<br> `120`: 120 minutes type: integer example: 60 sign_in_with_two_factor_auth: description: > Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). The value can be one of the following: `all`: Two factor authentication will be enabled for all users in the account.<br> `none`: Two factor authentication is disabled.<br> `group`: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field.<br> `role`: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the `sign_in_with_two_factor_auth_roles` field. enum: - all - group - role - none type: string example: group sign_in_with_two_factor_auth_groups: description: >- This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group` type: array items: type: string example: group sign_in_with_two_factor_auth_roles: description: >- This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`. type: array items: type: string example: role audio_conferencing: description: The account's audio conference settings. type: object properties: toll_free_and_fee_based_toll_call: description: >- The account's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) settings. type: object properties: allow_webinar_attendees_dial: description: >- Whether webinar attendees can dial in through the account's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available in version 5.2.2 and higher. type: boolean example: true enable: description: >- Whether the account has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. type: boolean example: true numbers: description: >- The account's **Toll-free and Fee-based Toll Call** phone number information. maxItems: 100 type: array items: type: object properties: code: description: >- The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). type: string example: '86' country_code: description: >- The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). type: string example: CN country_name: description: The country name. type: string example: China display_number: description: The phone number's display number. maxLength: 30 type: string example: +86 777 777 77 number: description: The phone number. maxLength: 30 type: string example: 777 777 77 chat: description: The account's chat settings. type: object properties: allow_bots_chat: description: >- Whether chatbots added to chats and channels can read and write messages. type: boolean example: true share_files: type: object description: Users can share files in chats and channels. properties: enable: type: boolean description: >- Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. example: true share_option: type: string description: >- Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. enum: - anyone - account - organization x-enum-descriptions: - Anyone (internal and external contacts) - In the same account - In the same organization example: true restrictions: type: object description: >- The restrictions of users can share files in chats and channels properties: only_allow_specific_file_types: type: boolean description: Only allow specified file types example: true file_type_restrictions: type: array items: type: string description: Specified file type example: .gz enum: - .gz - .rar - .zip - .xls - .xlsx - .json - .png - .pptx - .ppt - .7z - .xmind - .pdf - .pps - .txt - .docx - .doc file_type_restrictions_for_external: type: array items: type: string description: Specified file type example: .gz enum: - .gz - .rar - .zip - .xls - .xlsx - .json - .png - .pptx - .ppt - .7z - .xmind - .pdf - .pps - .txt - .docx - .doc maximum_file_size: type: boolean description: Whether to restrict file size example: true file_size_restrictions: type: integer description: Maximum file size example: 100 enum: - 50 - 100 - 200 - 300 - 400 - 500 file_size_restrictions_for_external: type: integer description: Maximum file size for external users example: 100 enum: - 50 - 100 - 200 - 300 - 400 - 500 chat_emojis: type: object description: Chat emojis. properties: enable: type: boolean description: >- Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings. example: true emojis_option: type: string example: all enum: - all - selected x-enum-descriptions: - All emojis - Selected emojis record_voice_messages: description: >- Allow users to record voice messages that can be sent in direct messages or group conversations. type: boolean example: true record_video_messages: description: >- Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages. type: boolean example: true screen_capture: description: >- Allow users to take and send screenshots in direct messages or group conversations. type: boolean example: true create_public_channels: type: boolean description: Allow users to create public channels. example: true create_private_channels: type: boolean description: Allow users to create private channels. example: true share_links_in_chat: type: boolean description: Share links to messages and channels in Team Chat. example: true schedule_meetings_in_chat: type: boolean description: Schedule a meeting from chat or channel. example: true set_retention_period_in_cloud: type: object description: Set retention period for messages and files in Zoom's cloud. properties: enable: type: boolean description: >- By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted. example: true retention_period_of_direct_messages_and_group_conversation: type: string description: >- Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day example: 2m retention_period_of_channels: type: string description: >- Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day example: 2m set_retention_period_in_local: type: object description: >- Store messages on local devices, excluding personal channel messages. properties: enable: type: boolean description: >- Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally. example: true retention_period_of_direct_messages_and_group_conversation: type: string description: >- Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day example: 2m retention_period_of_channels: type: string description: >- Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day example: 2m allow_users_to_add_contacts: description: Allow users to add contacts. type: object properties: enable: description: >- By disabling this setting, users will not be able to add contacts. type: boolean example: true selected_option: description: |- The type of allowing users to add contacts. * 1 — Anyone (internal and external contacts). * 2 — In the same organization. * 3 — In the same organization and specified domains. * 4 — In the same organization and specified users. enum: - 1 - 2 - 3 - 4 type: integer example: 4 user_email_addresses: description: >- The internal or external domains or emails. * When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. * When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails. type: string example: [email protected] allow_users_to_chat_with_others: description: Allow users to chat with others. type: object properties: enable: description: >- If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users. type: boolean example: true selected_option: description: |- The type of allowing users to add contacts. * 1 — Anyone (internal and external contacts). * 2 — In the same organization. * 3 — In the same organization and specified domains. * 4 — In the same organization and specified users. enum: - 1 - 2 - 3 - 4 type: integer example: 4 user_email_addresses: description: >- The internal or external domains or emails. * When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. * When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails. type: string example: [email protected] chat_etiquette_tool: description: Information about the **Chat Etiquette** tool. type: object properties: enable: default: false description: >- Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages. type: boolean example: true operate: description: |- The policy operation to perform for the update. * `create` — Create policies. * `update` — Update policies. * `delete` — Delete policies. enum: - create - update - delete type: string x-enum-descriptions: - Add new policies. - Update policies. - Delete policies. example: update policies: description: >- Information about the defined **Chat Etiquette Tool** policies. type: array items: type: object properties: description: description: The policy's description. type: string example: The policy's description id: description: The policy ID. type: string example: afwefwef243fwef132f2g43g43g44br is_locked: default: false description: >- Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`. type: boolean example: true keywords: description: A list of defined rule keywords. type: array items: type: string example: test name: description: The policy name. type: string example: the policy name regular_expression: description: >- The regular expression to match to the content of chat messages. type: string example: ^test status: description: |- The policy's current status. * `activated` — Activated. * `deactivated` — Deactivated. enum: - activated - deactivated type: string x-enum-descriptions: - Activated. - Deactivated. example: activated trigger_action: description: >- The policy's trigger action. * `1` — Ask the user to confirm before they send the message. * `2` — Block the user's message. enum: - 1 - 2 type: integer x-enum-descriptions: - >- Ask the user to confirm before they send the message. - Block the user's message. example: 1 send_data_to_third_party_archiving_service: type: object description: Send data to third-party archiving service. properties: enable: type: boolean description: Allow users to send data to third-party archiving service. example: true type: type: string description: |- The type of global relay. * `global_relay` — The participant cannot use chat. * `smarsh` — Host and co-hosts only. enum: - global_relay - smarsh x-enum-descriptions: - Global Relay - Smarsh example: global_relay smtp_delivery_address: type: string description: >- SMTP delivery address. It is used when the field `type` value is `global_relay`, and it is required. example: [email protected] user_name: type: string description: >- User name. It is used when the field `type` value is `global_relay`, and it is required. example: test passcode: type: string description: >- passcode. It is used when the field `type` value is `global_relay`, and it is required. example: '111111111' authorized_channel_token: type: string description: >- Authorized channel token. It is used when the field `type` value is `smarsh`, and it is required. example: >- as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq apply_local_storage_to_personal_channel: type: object description: Store personal channel messages on local devices. properties: enable: type: boolean description: >- Specify how long your messages sent in your personal channel are saved on local devices. If this setting is disabled, messages are never deleted locally. example: true retention_period: type: string description: >- Delete data after retention period. 'y' - year, 'm' - month, 'd' - day. example: 2m email_notification: description: 'Account Settings: Notification.' type: object properties: alternative_host_reminder: description: >- Notify when an alternative host is set or removed from a meeting. type: boolean example: true cancel_meeting_reminder: description: Notify the host and participants when a meeting is cancelled. type: boolean example: true cloud_recording_available_reminder: description: >- Whether to notify the host when a cloud recording is available. type: boolean example: true jbh_reminder: description: >- Notify the host when participants join the meeting before them. type: boolean example: true low_host_count_reminder: description: Notify user when host licenses are running low. type: boolean example: true recording_available_reminder_alternative_hosts: description: >- Whether to notify any alternative hosts when a cloud recording is available. type: boolean example: true recording_available_reminder_schedulers: description: >- Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. type: boolean example: true schedule_for_reminder: description: >- Notify the host there is a meeting is scheduled, rescheduled, or cancelled. type: boolean example: true feature: description: 'Account Settings: Feature.' type: object properties: meeting_capacity: description: >- Set the maximum number of participants a host can have in a single meeting. type: integer example: 50 in_meeting: description: In Meeting Account Settings type: object properties: alert_guest_join: description: >- Whether to enable [guest participant](https://support.zoom.us/hc/en-us/articles/115004791123-Identifying-guests-in-the-meeting-webinar) alerts. type: boolean example: true allow_users_to_delete_messages_in_meeting_chat: description: > If the value of this field is set to `true`, allow users to delete messages in the in-meeting chat. type: boolean example: true allow_host_to_enable_focus_mode: description: >- Whether the host can enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting. This value defaults to `null`. type: boolean example: true allow_live_streaming: description: Whether to allow livestreaming. type: boolean example: true allow_participants_chat_with: description: >- Whether to allow participants to only chat with certain groups: * `1` — The participant cannot use chat. * `2` — Host and co-hosts only. * `3` — The participant can chat with other participants publicly. * `4` - The participant can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. enum: - 1 - 2 - 3 - 4 type: integer example: 1 allow_participants_to_rename: description: >- Whether to allow meeting participants to rename themselves during a meeting. type: boolean example: true allow_show_zoom_windows: description: >- Whether to enable the [**Show Zoom windows during screen share**](https://support.zoom.us/hc/en-us/articles/360061383571-Showing-Zoom-windows-during-screen-share) feature. type: boolean example: true allow_users_save_chats: description: >- Whether to allow participants to save meeting chats: * `1` — Participants cannot save meeting chats. * `2` — Participants can only save host and co-host meeting chats. * `3` — Participants can save all meeting chats. enum: - 1 - 2 - 3 type: integer example: 1 annotation: description: >- Whether to allow meeting participants to use the [annotation tools](https://support.zoom.us/hc/en-us/articles/115005706806). type: boolean example: true anonymous_question_answer: description: Whether to enable anonymous Q&A. type: boolean example: true attendee_on_hold: deprecated: true default: false description: >- Whether to allow the host to put an attendee on hold. This value defaults to `false`. **This field has been deprecated and is no longer supported.** type: boolean example: true attention_mode_focus_mode: default: false description: >- Whether to enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode). When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. This value defaults to `false`. type: boolean example: true auto_answer: description: >- Whether to enable the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) setting. Calls from these group members will be answered automatically. type: boolean example: true auto_saving_chat: description: Whether to automatically save all in-meeting chats. type: boolean example: true breakout_room: description: >- Whether to allow the meeting host to split meeting participants into separate breakout rooms. type: boolean example: true breakout_room_schedule: description: >- Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. type: boolean example: true chat: description: Whether to enable chat during meeting for all participants. type: boolean example: true meeting_question_answer: description: >- Allow participants to ask questions for the host and participants to answer. type: boolean example: true closed_caption: description: Whether to enable closed captions. type: boolean example: true closed_captioning: description: Information about the account's closed captioning settings. type: object properties: auto_transcribing: description: >- Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB). type: boolean example: true enable: description: >- Whether to enable [closed captioning and transcription services](https://support.zoom.us/hc/en-us/articles/4409683389709-Enabling-or-disabling-closed-captioning-and-live-transcription-services). type: boolean example: true save_caption: description: >- Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). **Note:** If the `view_full_transcript` field is set to `false`, participants **cannot** save captions. type: boolean example: true third_party_captioning_service: description: >- Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning. type: boolean example: true view_full_transcript: description: >- Whether to enable the viewing of full transcripts in the in-meeting side panel. type: boolean example: true co_host: description: Whether to allow the host to add co-hosts. type: boolean example: true custom_data_center_regions: description: >- Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): * `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. * `false` — Only use the default data center regions. type: boolean example: true custom_live_streaming_service: description: Whether to allow custom livestreaming. type: boolean example: true custom_service_instructions: description: The specific instructions to configure a custom livestream. type: string example: The specific instructions data_center_regions: type: array description: >- If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: * `AU` — Australia. * `LA` — Latin America. * `CA` — Canada. * `CN` — China. * `DE` — Germany. * `HK` — Hong Kong SAR. * `IN` — India. * `IE` — Ireland. * `TY` — Japan. * `MX` — Mexico. * `NL` — Netherlands. * `SG` — Singapore. * `US` — United States. items: type: string enum: - AU - LA - CA - CN - DE - HK - IN - IE - TY - MX - NL - SG - US example: AU disable_screen_sharing_for_host_meetings: description: >- Whether to enable the **Disable desktop screen sharing for meetings you host** setting. type: boolean example: true disable_screen_sharing_for_in_meeting_guests: description: >- Whether to enable the **Disable screen sharing when guests are in the meeting** setting. type: boolean example: true dscp_audio: default: 56 description: The DSCP audio marking value. This value defaults to `56`. maximum: 63 minimum: 1 type: integer example: 56 dscp_marking: description: >- Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking. type: boolean example: true dscp_video: default: 40 description: The DSCP video marking value. This value defaults to `40`. maximum: 63 minimum: 1 type: integer example: 40 dscp_dual: type: boolean description: >- Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing). example: false e2e_encryption: description: >- Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings. type: boolean example: true entry_exit_chime: description: |- When to play the meeting entry/exit sound notification: * `host` — Only when the host joins or leaves. * `all` — When any participant joins or leaves. * `none` - Disable the entry/exit sound notification. enum: - host - all - none type: string example: host far_end_camera_control: description: >- Whether to allow another user to take control of the user's camera. type: boolean example: true feedback: description: >- Whether to enable the [**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023-Feedback-to-Zoom) setting. type: boolean example: true file_transfer: description: >- Whether to enable the [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting. type: boolean example: true group_hd: description: Whether to enable group HD video. type: boolean example: true join_from_desktop: description: >- Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited. type: boolean example: true join_from_mobile: description: >- Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited. type: boolean example: true auto_generated_translation: description: >- Information about the [Translate captions](https://support.zoom.us/hc/en-us/articles/8158738379917-Managing-automated-captions-) settings in meetings. type: object properties: language_item_pairList: description: >- Information about all speak languages and translation languages in meetings. type: object properties: trans_lang_config: type: array description: A list of speak languages and translation languages. items: type: object description: >- A item of speak language and translation languages in meetings. properties: speak_language: type: object description: language used in meetings properties: name: type: string enum: - Chinese (Simplified) - Dutch - English - French - German - Italian - Japanese - Korean - Portuguese - Russian - Spanish - Ukrainian example: Chinese (Simplified) description: the name of language code: type: string enum: - zh - nl - en - fr - de - it - ja - ko - pt - ru - es - uk example: zh description: th code for the language translate_to: type: object description: Information about all the translation languages. properties: all: type: boolean example: true description: >- Whether to select all the translation languages language_config: type: array description: A list of the translation languages. items: type: object description: A item of translation languages. properties: name: type: string example: English enum: - English description: the name of translation language code: type: string enum: - en example: en description: the code of translation language all: description: >- Whether to select all speak languages and translation languages type: boolean example: true enable: description: >- Whether to allow users to enable automated translated captions in these language pairs in meetings. type: boolean example: true language_interpretation: description: >- Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings. type: object properties: custom_languages: description: A list of user-defined supported languages. type: array items: type: string example: English enable_language_interpretation_by_default: description: Whether enable language interpretation by default. type: boolean example: true allow_participants_to_speak_in_listening_channel: description: >- Whether to allow participants to speak in listening channel. type: boolean example: true allow_up_to_25_custom_languages_when_scheduling_meetings: description: >- Whether to allow up to 25 custom languages when scheduling meetings. type: boolean example: true enable: description: >- Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time. type: boolean example: true live_streaming_facebook: description: Whether to allow Facebook livestreaming. type: boolean example: true live_streaming_youtube: description: Whether to allow YouTube livestreaming. type: boolean example: true manual_captioning: description: Information about manual captioning settings. type: object properties: allow_to_type: description: >- Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning. type: boolean example: true auto_generated_captions: description: >- Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB). type: boolean example: true full_transcript: description: >- Whether to enable the viewing of full transcripts in the in-meeting side panel. type: boolean example: true manual_captions: description: >- Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription). type: boolean example: true save_captions: description: >- Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions. type: boolean example: true third_party_captioning_service: description: >- Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning. type: boolean example: true meeting_reactions: description: >- Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar. type: boolean example: true meeting_reactions_emojis: description: >- Choose from the following meeting reaction options: * `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. * `selected` — Selected emojis: Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) type: string enum: - all - selected x-enum-descriptions: - >- Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. - >- Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) . example: all allow_host_panelists_to_use_audible_clap: description: Whether to allow host and panelist to use audible clap. type: boolean example: true webinar_reactions: description: >- Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). type: boolean example: true meeting_survey: description: >- Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. type: boolean example: true original_audio: description: >- Whether to allow users to select original sound in their client settings. type: boolean example: true p2p_connetion: description: >- Whether to enable the [**Peer to Peer connection while only 2 people are in a meeting**](https://support.zoom.us/hc/en-us/articles/360061410851-Enabling-Peer-to-Peer-connection-for-2-people-in-a-meeting) setting. type: boolean example: true p2p_ports: description: Whether to enable the **Listening ports range** setting. type: boolean example: true polling: description: Whether to add polls to the meeting controls. type: boolean example: true meeting_polling: type: object description: Information about the account's meeting polling settings. properties: enable: type: boolean description: >- Whether to allow the host to add polls before or during a meeting. example: true advanced_polls: type: boolean description: >- Whether to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create. example: true require_answers_to_be_anonymous: description: Whether to require answers to be anonymous. type: boolean example: true manage_saved_polls_and_quizzes: description: >- Whether to allow users to manage saved polls and quizzes from Meetings type: boolean example: true allow_alternative_host_to_add_edit: type: boolean description: >- Whether to allow the alternative host to add or edit polls and quizzes. example: true allow_host_to_upload_image: description: >- Whether to allow host to upload an image for each question. type: boolean example: true ports_range: default: '' description: >- When the `p2p_ports` value is `true`, the value is a semi-colon list of the peer to peer listening ports range, between `1` to `65535`. This value defaults to an empty string. type: string example: 1;65535 post_meeting_feedback: description: >- Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. type: boolean example: true private_chat: description: >- Whether to [enable private chat](https://support.zoom.us/hc/en-us/articles/360060835932-Enabling-and-disabling-private-chat) between participants during meetings. type: boolean example: true record_play_own_voice: description: Whether to let the user record and play their own voice. type: boolean example: true remote_control: description: >- Whether to enable the [**Remote control**](https://support.zoom.us/hc/en-us/articles/201362673-Requesting-or-giving-remote-control) setting. type: boolean example: true non_verbal_feedback: default: false description: >- Whether to enable the [**Non-verbal feedback**](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-) setting. This value defaults to `false`. type: boolean example: true remote_support: default: false description: >- Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`. type: boolean example: true request_permission_to_unmute_participants: type: boolean description: >- Whether to enable the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting) setting. example: true screen_sharing: description: >- Whether to allow hosts and participants to share their screen or content during meetings. type: boolean example: true sending_default_email_invites: description: >- Whether to enable the [**Only show default email when sending email invites**](https://support.zoom.us/hc/en-us/articles/360061433531-Showing-default-email-when-sending-email-invites) setting. type: boolean example: true show_a_join_from_your_browser_link: description: >- 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. type: boolean example: true show_meeting_control_toolbar: description: Whether to display the in-meeting control toolbar. type: boolean example: true slide_control: description: >- Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher. type: boolean example: true stereo_audio: description: >- Whether to allow users to select stereo audio in their client settings. type: boolean example: true use_html_format_email: description: >- Whether to enable the use of HTML-formatted emails for the Outlook plugin. type: boolean example: true virtual_background: description: Whether to enable Virtual Backgrounds. type: boolean example: true virtual_background_settings: description: The account's Virtual Background settings. type: object properties: allow_upload_custom: description: >- Whether to allow user to upload custom Virtual Backgrounds. type: boolean example: true allow_videos: description: >- Whether to allow the use of videos for Virtual Backgrounds. type: boolean example: true enable: description: Whether to enable Virtual Backgrounds. type: boolean example: true files: description: Information about the Virtual Background files. type: array items: type: object properties: id: description: The Virtual Background file's ID. type: string example: 13refwef43svSFrwfrgfsrwrfew is_default: description: >- Whether the file is the default Virtual Background file. type: boolean example: true name: description: The Virtual Background file's name. type: string example: test.png size: description: The Virtual Background file's size, in bytes. type: integer example: 1235 type: description: The Virtual Background file's type. type: string example: image watermark: description: >- Whether to include a [watermark](https://support.zoom.us/hc/en-us/articles/209605273-Adding-an-image-watermark) when viewing a shared screen. type: boolean example: true webinar_chat: description: Information about the account's webinar chat settings. type: object properties: allow_attendees_chat_with: description: |- Allow webinar attendees to chat with: * `1` — No one. * `2` — Host and all panelists. * `3` — Everyone. enum: - 1 - 2 - 3 type: integer example: 1 allow_auto_save_local_chat_file: description: >- Whether to automatically save chat messages to a local file on the host's computer when the webinar ends. type: boolean example: true allow_panelists_chat_with: description: |- Allow webinar panelists to chat with: * `1` — Host and all panelists. * `2` — Everyone. enum: - 1 - 2 type: integer example: 1 allow_panelists_send_direct_message: description: >- Whether to allow webinar panelists to send direct messages to other panelists. type: boolean example: true allow_users_save_chats: description: |- Whether to allow webinar attendees to save chats: * `0` — Attendees cannot save chats. * `1` — Attendees can only save host and panelist chats. * `2` — Attendees can save all chats. enum: - 0 - 1 - 2 type: integer example: 1 default_attendees_chat_with: description: |- By default, allow webinar attendees to chat with: * `1` — Host and all panelists. * `2` — Everyone. enum: - 1 - 2 type: integer example: 1 enable: description: >- Whether to allow webinar participants to send chat messages. type: boolean example: true webinar_live_streaming: type: object properties: custom_service_instructions: description: >- The specific instructions to allow the account's meeting hosts to configure a custom livestream. type: string example: The specific instructions enable: description: Whether to enable webinar livestreaming. type: boolean example: true live_streaming_reminder: description: >- Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). type: boolean example: true live_streaming_service: description: >- The available livestreaming services: * `facebook` — Facebook. * `workplace_by_facebook` — Workplace by Facebook. * `youtube` — YouTube. * `custom_live_streaming_service` — Custom Live Streaming Service. type: array items: enum: - facebook - workplace_by_facebook - youtube - custom_live_streaming_service type: string example: facebook webinar_polling: description: Information about the account's webinar polling settings. type: object properties: enable: description: >- Whether to allow the host to add polls before or during a webinar. type: boolean example: true advanced_polls: description: >- Whether to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create. type: boolean example: true require_answers_to_be_anonymous: description: Whether to require answers to be anonymous. type: boolean example: true manage_saved_polls_and_quizzes: description: >- Whether to allow users to manage saved polls and quizzes from Meetings type: boolean example: true allow_alternative_host_to_add_edit: type: boolean description: >- Whether to allow the alternative host to add or edit polls and quizzes. example: true allow_host_to_upload_image: description: >- Whether to allow host to upload an image for each question. type: boolean example: true webinar_question_answer: description: >- Whether attendees can ask the host and panelists questions in the webinar. type: boolean example: true webinar_survey: description: >- Whether to allow the host to present surveys to attendees once a webinar has ended. type: boolean example: true whiteboard: description: >- Whether to enable the [**Zoom Whiteboard**](https://support.zoom.us/hc/en-us/articles/4410916881421) feature. type: boolean example: true who_can_share_screen: description: >- The type of user who can share their screen or content during meetings: * `host` — Only hosts can screen share. * `all` — Both hosts and participants can screen share. enum: - host - all type: string example: host who_can_share_screen_when_someone_is_sharing: description: >- The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: * `host` — Only hosts can screen share when someone else is sharing. * `all` — Both hosts and participants can screen share when someone else is sharing. enum: - host - all type: string example: all participants_share_simultaneously: description: >- Indicates how many participants can share at the same time. The value can be one of the following:<br> `one`: Only one participant can share at a time .<br> `multiple`: Multiple participants can share simultaneously (dual monitors recommended). enum: - multiple - one type: string example: multiple workplace_by_facebook: description: Whether to allow Workplace by Facebook livestreaming. type: boolean example: true transfer_meetings_between_devices: description: >- Users can move to a new device without leaving the meeting they're in. type: boolean example: true integration: description: 'Account Settings: Integration.' type: object properties: box: description: >- Enable users who join a meeting from their mobile device to share content from their Box account. type: boolean example: true dropbox: description: >- Enable users who join a meeting from their mobile device to share content from their Dropbox account. type: boolean example: true google_calendar: description: Enable meetings to be scheduled using Google Calendar. type: boolean example: true google_drive: description: >- Enable users who join a meeting from their mobile device to share content from their Google Drive. type: boolean example: true kubi: description: >- Enable users to control a connected Kubi device from within a Zoom meeting. type: boolean example: true microsoft_one_drive: description: >- Enable users who join a meeting from their mobile device to share content from their Microsoft OneDrive account. type: boolean example: true other_options: type: object properties: allow_auto_active_users: description: >- Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password. type: boolean example: true allow_users_contact_support_via_chat: description: >- Whether to display the Zoom Help badge on the bottom-right of the page. type: boolean example: true allow_users_enter_and_share_pronouns: description: >- Whether users can add pronouns to their profile cards and share them during meetings and webinars. type: boolean example: true blur_snapshot: description: >- Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps. type: boolean example: true display_meetings_scheduled_for_others: description: >- Whether a user with the [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings. type: boolean example: true meeting_qos_and_mos: description: >- The Dashboard meeting [quality scores and network alerts](https://support.zoom.us/hc/en-us/articles/360061244651) setting: * `0` — Do not enable meeting quality scores and network alerts on the Dashboard. * `1` — Display the meeting quality score and network alerts on the Dashboard. * `2` — Use custom thresholds for quality scores and network alerts. * `3` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard. enum: - 0 - 1 - 2 - 3 type: integer x-enum-descriptions: - >- Do not display meeting quality scores and network alerts on the Dashboard - >- Display the meeting quality score and network alerts on the Dashboard - Use custom thresholds for quality scores and network alerts example: 0 show_one_user_meeting_on_dashboard: description: >- Whether meetings with only one person will display on the Dashboard and in reports. type: boolean example: true use_cdn: description: >- Allow connections to different CDNs (content delivery networks) for a better web browsing experience. All users in your organization will use the selected CDN to access static resources: * `none` — Do not use a CDN. * `default` — Use the Amazon CloudFront CDN for users **except** Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). * `wangsu` — Use the Wangsu CDN for all users. enum: - none - default - wangsu type: string x-enum-descriptions: - Do not use use a CDN - >- All users will use the Amazon CloudFront CDN except Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China) - All users use the Wangsu CDN (China) example: none webinar_registration_options: type: object description: Webinar registration options. properties: allow_host_to_enable_join_info: type: boolean description: >- Allow host to enable "Show join info on registration confirmation page". example: true allow_host_to_enable_social_share_buttons: type: boolean description: >- Allow host to enable "Show social share buttons on registration page". example: true enable_custom_questions: type: boolean description: Enable custom questions. example: true profile: title: Profile type: object properties: recording_storage_location: type: object properties: allowed_values: description: >- Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details. Provide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details. type: array items: type: string example: US value: description: Abbreviated country code. type: string example: US recording: description: 'Account Settings: Recording.' type: object properties: account_user_access_recording: description: >- Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings. type: boolean example: true allow_recovery_deleted_cloud_recordings: description: >- Allow 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. type: boolean example: true archive: description: >- [Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team. type: object properties: enable: description: Enable the archiving feature. type: boolean example: true settings: type: object properties: audio_file: description: >- Include in-meeting and/or in-webinar audio in the archive. type: boolean example: true cc_transcript_file: description: Include closed caption or transcript in the archive. type: boolean example: true chat_file: description: Include in-meeting chat in the archive. type: boolean example: true chat_with_sender_email: description: Include user email in in-meeting chat file. type: boolean example: true video_file: description: >- Include in-meeting and/or in-webinar video in the archive. type: boolean example: true chat_with_direct_message: description: Include direct message in in-meeting chat file. type: boolean example: true archive_retention: description: The retention period for archiving content, in days. type: integer example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 action_when_archive_failed: description: >- Perform the action when meetings or webinars cannot be archived.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting. type: integer example: 1 enum: - 1 - 2 notification_when_archiving_starts: description: >- Show notification when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting. type: string example: participants enum: - participants - guest play_voice_prompt_when_archiving_starts: description: >- Play voice prompt when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting. type: string example: guest enum: - participants - guest - none type: description: |- Archive types: * `1`: Only meetings are archived.<br> * `2`: Only webinars are archived.<br> * `3`: Both meetings and webinars are archived. enum: - 1 - 2 - 3 type: integer example: 1 auto_delete_cmr: description: >- Allow Zoom to permanently delete recordings automatically after a specified number of days. type: boolean example: true auto_delete_cmr_days: description: >- When the `auto_delete_cmr` value is `true`, this value is the number of days before the auto-deletion of cloud recordings: * `30` — 30 days. * `60` — 60 days. * `90` — 90 days. * `120` — 120 days. enum: - 30 - 60 - 90 - 120 type: integer x-enum-descriptions: - 30 days. - 60 days. - 90 days. - 120 days. example: 90 record_files_separately: type: object description: >- The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings. properties: active_speaker: type: boolean description: Whether to record the active speaker only. example: true gallery_view: type: boolean description: Whether to record the gallery view only. example: true shared_screen: type: boolean description: Whether to record the shared screen only. example: true display_participant_name: type: boolean description: Whether to display participants' names in the recording. example: true recording_thumbnails: type: boolean description: >- Whether to record thumbnails of the presenter when they are sharing their screen. example: true optimize_recording_for_3rd_party_video_editor: type: boolean description: >- Whether to optimize recordings for a 3rd party video editor. This may increase the file size and the time it takes to generate recording files. example: true recording_highlight: type: boolean description: >- Whether to enable the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature. example: true deprecated: true save_panelist_chat: type: boolean description: >- Whether to save panelist chat to the recording. This setting saves messages sent by panelists during a webinar to either all panelists or all panelists and attendees to the recording. example: true save_poll_results: type: boolean description: >- Whether to save poll results shared during the meeting or webinar. This also includes poll results shared during the meeting or webinar. example: true save_close_caption: type: boolean description: >- Whether to save [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) as a VTT (Video Track Text) file. example: true auto_recording: description: >- Automatic recording:<br>`local` - Record on local.<br>`cloud` - Record on cloud.<br>`none` - Disabled. enum: - local - cloud - none type: string x-enum-descriptions: - Record on local - Record on cloud - Disabled example: local cloud_recording: description: Allow hosts to record and save the meeting in the cloud. type: boolean example: true cloud_recording_download: description: Cloud recording downloads. type: boolean example: true cloud_recording_download_host: description: Only the host can download cloud recordings. type: boolean example: true host_delete_cloud_recording: description: > 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 admin can delete them. type: boolean example: true ip_address_access_control: description: > Setting to allow cloud recording access only from specific IP address ranges. type: object properties: enable: description: >+ 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. type: boolean example: true ip_addresses_or_ranges: description: >+ IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number. Example: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157` type: string example: 46.33.24.184 local_recording: description: >- Allow hosts and participants to record the meeting using a local file. type: boolean example: true prevent_host_access_recording: description: > If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them. type: boolean example: true record_audio_file: description: Whether to record one audio file for all participants. type: boolean example: true record_gallery_view: description: Record the gallery view with a shared screen. type: boolean example: true record_speaker_view: description: Record the active speaker with a shared screen. type: boolean example: true recording_audio_transcript: description: >- Automatically transcribe the audio of the meeting or webinar to the cloud. type: boolean example: true recording_disclaimer: description: | Show a disclaimer to participants before a recording starts type: boolean example: true smart_recording: description: >- By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights. type: object properties: create_recording_highlights: description: >- By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete. type: boolean example: true create_smart_chapters: description: >- By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters. type: boolean example: true create_next_steps: description: >- By selecting this option, there will be a summary of actions to take after the recorded meeting. type: boolean example: true recording_password_requirement: description: >- This object represents the minimum password requirements set for recordings via Account Recording Settings. type: object properties: have_letter: description: >- Indicates whether or not password must contain at least one alphabetical letter (a, b, c..). type: boolean example: true have_number: description: >- Indicates whether or not password must contain at least one number(1, 2, 3..). type: boolean example: true have_special_character: description: >- Indicates whether or not password must contain at least one special character(!, @, #..). type: boolean example: true length: description: Minimum required length for the password. maximum: 10 type: integer example: 10 only_allow_numeric: description: >- Indicates whether or not password must contain only numeric characters. type: boolean example: true required_password_for_existing_cloud_recordings: description: Require a passcode to access existing cloud recordings. type: boolean example: true required_password_for_shared_cloud_recordings: type: boolean description: Whether to require a passcode to share cloud recordings. example: true save_chat_text: description: Save the chat text from the meeting. type: boolean example: true show_timestamp: description: Add a timestamp to the recording. type: boolean example: true schedule_meeting: description: 'Account Settings: Schedule Meeting.' type: object properties: audio_type: default: both description: >- Determine how participants can join the audio portion of the meeting.<br>`both` - Telephony and VoIP.<br>`telephony` - Audio PSTN telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - 3rd party audio conference. enum: - both - telephony - voip - thirdParty type: string x-enum-descriptions: - Telephony and VoIP - Audio PSTN telephony only - VoIP only - 3rd party audio conference example: both enforce_login: description: Only Zoom users who are signed in can join meetings. type: boolean example: true enforce_login_domains: description: >- Only signed in users with a specified domain can join the meeting. type: string example: example.com enforce_login_with_domains: description: Only signed in users with a specific domain can join meetings. type: boolean example: true force_pmi_jbh_password: description: >- Require a password for Personal Meetings if attendees can join before host. type: boolean example: true host_video: description: Start meetings with the host video on. type: boolean example: true jbh_time: description: >- If the value of "join_before_host" field is set to `true`, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following: * `0`: Allow participant to join anytime. * `5`: Allow participant to join 5 minutes before meeting start time. * `10`: Allow participant to join 10 minutes before meeting start time. enum: - 0 - 5 - 10 - 15 type: integer example: 10 join_before_host: description: >- Allow participants to join the meeting before the host arrives. type: boolean example: true meeting_password_requirement: description: >- Account wide meeting or webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604). type: object properties: consecutive_characters_length: description: >- Specify the max length of consecutive characters(abcde...) that can be used in a password. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password. The max allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh). enum: - 0 - 4 - 5 - 6 - 7 - 8 type: integer example: 5 have_letter: description: > If set to `true`, the password must contain at least 1 letter (such as a,b,c...). type: boolean example: true have_number: description: >- If set to `true`, the password must contain at least 1 number (such as 1,2,3...). type: boolean example: true have_special_character: description: >- If set to `true`, the password must have at least 1 special character (!,@,#...). type: boolean example: true have_upper_and_lower_characters: description: >- If set to `true`, the password must include both uppercase and lowercase characters. type: boolean example: true length: description: >- The minimum length that the meeting or webinar password must have. type: integer example: 10 only_allow_numeric: description: >- If set to `true`, the password must only contain numbers and no other characters. type: boolean example: true weak_enhance_detection: description: >- If set to `true`, users will be informed if the provided password is weak. type: boolean example: true not_store_meeting_topic: description: Always display "Zoom Meeting" as the meeting topic. type: boolean example: true participant_video: description: >- Start meetings with the participant video on. Participants can change this setting during the meeting. type: boolean example: true personal_meeting: description: >+ Personal Meeting Setting.<br><br> `true`: Indicates that the **"Enable Personal Meeting ID"** setting is turned on. Users can choose to use personal meeting ID for their meetings. <br><br> `false`: Indicates that the **"Enable Personal Meeting ID"** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with a PMI will be invalid. Scheduled meetings will need to be manually updated. For Zoom Phone only: If a user has been assigned a desk phone, **"Elevate to Zoom Meeting"** on desk phone will be disabled. type: boolean example: true require_password_for_instant_meetings: description: > Require a password for instant meetings. If you use a 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. type: boolean example: true require_password_for_pmi_meetings: description: > Require a password for a meeting held using a 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. enum: - jbh_only - all - none type: string x-enum-descriptions: - Only meetings with Join Before Host enabled - All meetings using PMI - All meetings using a PMI - Disabled example: none require_password_for_scheduled_meetings: description: > Require a password for meetings which have already been scheduled. type: boolean example: true require_password_for_scheduling_new_meetings: description: >- Require a password when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts. type: boolean example: true use_pmi_for_instant_meetings: description: >- Use a Personal Meeting ID (PMI) when starting an instant meeting. type: boolean example: true use_pmi_for_scheduled_meetings: description: Use a Personal Meeting ID (PMI) when scheduling a meeting. type: boolean example: true always_display_zoom_meeting_as_topic: description: >- Information about the [**Always display "Zoom Meeting" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting. type: object properties: enable: type: boolean description: >- Whether to enable the **Always display "Zoom Meeting" as the meeting topic** setting. example: true display_topic_for_scheduled_meetings: type: boolean description: >- Whether to display "Zoom Meeting" as the topic for already-scheduled meetings. example: true hide_meeting_description: type: object description: Information about the **Hide meeting description** feature. properties: enable: type: boolean description: >- Whether to enable the **Hide meeting description** setting. example: true hide_description_for_scheduled_meetings: type: boolean description: >- Whether to hide the description for already-scheduled meetings. example: true always_display_zoom_webinar_as_topic: type: object description: >- Information about the [**Always show "Zoom Webinar" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting. properties: enable: type: boolean description: >- Whether to enable the **Always show "Zoom Webinar" as the webinar topic** setting. example: true display_topic_for_scheduled_webinars: type: boolean description: >- Whether to display "Zoom Webinar" as the topic for already-scheduled meetings. example: true hide_webinar_description: type: object description: Information about the **Hide webinar description** feature. properties: enable: type: boolean description: >- Whether to enable the **Hide webinar description** setting. example: true hide_description_for_scheduled_webinars: type: boolean description: >- Whether to hide webinar description for the webinars which have already been scheduled. example: true telephony: description: 'Account Settings Update: Telephony.' type: object properties: audio_conference_info: description: Third party audio conference info. type: string example: test telephony_regions: description: >- Indicates where most of the participants call into or call from during a meeting. type: object properties: selection_values: description: >- The account's selected telephony regions that indicate where most participants call into or call from during a meeting. type: string example: USTB third_party_audio: description: >- Users can join the meeting using the existing third party audio configuration. type: boolean example: true tsp: description: 'Account Settings: TSP.' type: object properties: call_out: description: Call Out type: boolean example: true call_out_countries: description: Call Out Countries/Regions type: array items: type: string example: us display_toll_free_numbers: description: Display toll-free numbers type: boolean example: true show_international_numbers_link: description: Show international numbers link on the invitation email type: boolean example: true zoom_rooms: description: 'Account Settings: Zoom Rooms.' type: object properties: auto_start_stop_scheduled_meetings: description: Automatic start and stop for scheduled meetings. type: boolean example: true cmr_for_instant_meeting: description: Cloud recording for instant meetings. type: boolean example: true force_private_meeting: description: Shift all meetings to private. type: boolean example: true hide_host_information: description: Hide host and meeting ID from private meetings. type: boolean example: true list_meetings_with_calendar: description: Display meeting list with calendar integration. type: boolean example: true start_airplay_manually: description: Start AirPlay service manually. type: boolean example: true ultrasonic: description: Automatic direct sharing using an ultrasonic proximity signal. type: boolean example: true upcoming_meeting_alert: description: Upcoming meeting alert. type: boolean example: true weekly_system_restart: description: Weekly system restart. type: boolean example: true zr_post_meeting_feedback: description: Zoom Room post meeting feedback. type: boolean example: true title: Information about the account's updated settings. type: object - oneOf: - description: >- Set/ update [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).<br><br> The authentication profile **must first be set at the account level via the account settings**, and later can be disabled after enabling on the preferred level - i.e. user level using user settings or at group level via group settings (if you do not want the settings to be enabled on the entire account). properties: allow_authentication_exception: description: >- Whether to enable the [**Allow authentication exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY) setting. This lets hosts invite users who can bypass authentication. type: boolean example: true authentication_option: description: Meeting Authentication Options type: object properties: action: description: >- Specify the action that you would like to take via this API request:<br> * `add` : Choose this value if you are adding an authentication option. * `update`: Choose this value if you are updating an existing authentication option. * `delete`: Choose this value if you are deleting an existing authentication option. enum: - update - delete - add type: string example: update default_option: description: >- Specify whether you would like to set this authentication option as the default option or not. type: boolean example: true domains: description: >- If you chose `enforce_login_with_domains` as the authentication type, specify the domain(s) that you want to allow to join your meetings or webinars. type: string example: example.com id: description: |2- Authentication ID. If you are creating an authentication profile, you do not need to provide this field. The id field will be generated in the response once this API request is completed successfully. You can also use the Get Account Settings API with query parameter set to `meeting_authentication` to list the authentication id.<br><br> Use this field or the `name` field to identify the associated authentication option that you would like to update or delete. type: string example: 13rfefrg43erberbre name: description: Unique name for the authentication option. type: string example: test name type: description: |2- Authentication type. Specify one of the following authentication types for the authentication profile:<br> * `enforce_login`: This option allows any users to join the meeting or webinar, as long as they are signed into their Zoom account. * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can join the meeting or webinar. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.<br> * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account. enum: - enforce_login - enforce_login_with_same_account - enforce_login_with_domains type: string example: enforce_login_with_domains meeting_authentication: description: >- If set to "true", only authenticated users can join meetings. The method for authentication can be defined in the "authentication_option". type: boolean example: true type: object - description: >- Set/Update [authentication profile for Cloud Recordings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings). properties: authentication_option: description: Specify the authentication options for this account. type: object properties: action: description: >- Specify the action that you would like to take via this API request:<br> * `add` : Choose this value if you are adding an authentication option. * `update`: Choose this value if you are updating an existing authentication option. * `delete`: Choose this value if you are deleting an existing authentication option. enum: - update - delete - add type: string example: update default_option: description: >- Specify whether you would like to set this authentication option as the default option or not. type: boolean example: true domains: description: >- If you chose `enforce_login_with_domains` as the authentication type, specify the domain(s) that you want to allow to view the recordings. type: string example: example.com id: description: >2- Authentication ID. If you are creating an authentication profile, you do not need to provide this field. The id field will be generated in the response once this API request is completed successfully. You can also use the Get Account Settings API with query parameter set to `meeting_authentication` to list the authentication id.<br><br> Use this field or the `name` field to identify the associated authentication option that you would like to update or delete. type: string example: dsfwefweff32324 name: description: Unique name for the authentication option. type: string example: Unique name type: description: >+ Specify one authentication type that is to be associated with this authentication configuration:<br> * `internally`: This option allows you specify a rule that only signed in users within your account can view the recording.<br> * `enforce_login`: This option allows any users to view the recording, as long as they are signed into their Zoom account.<br> * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can view the recording. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains. enum: - internally - enforce_login - enforce_login_with_domains type: string example: enforce_login_with_domains recording_authentication: description: >- If set to `true`, only authenticated users can view the cloud recordings.<br><br> The authentication profile **must first be set at the account level via the account settings**, and later can be disabled after enabling on the preferred level - i.e. user level using user settings or at group level via group settings (if you do not want the settings to be enabled on the entire account). type: boolean example: true type: object title: AccountSettingsAuthenticationUpdate type: object - description: The account's updated meeting and webinar security settings. properties: meeting_security: type: object properties: auto_security: description: >- Whether to require that all meetings are secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts. type: boolean example: true block_user_domain: description: >- Whether to block users in specific domains from joining meetings and webinars. type: boolean example: true block_user_domain_list: description: >- The domain to block, up to 20 domains. For example, the `*.example.com` domain. maxItems: 20 type: array items: maxLength: 30 minLength: 5 type: string example: example.com chat_etiquette_tool: description: Information about the **Chat Etiquette** Tool. type: object properties: enable: default: false description: >- Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages. type: boolean example: true operate: description: |- The policy operation to perform for the update: * `create` — Create policies. * `update` — Update policies. * `delete` — Delete policies. enum: - create - update - delete type: string x-enum-descriptions: - Add new policies. - Update policies. - Delete policies. example: update policies: description: >- Information about the defined **Chat Etiquette Tool** policies. type: array items: type: object properties: description: description: The policy's description. type: string example: The policy's description id: description: The policy ID. type: string example: afwefwef243fwef132f2g43g43g44br is_locked: default: false description: >- Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`. type: boolean example: true keywords: description: A list of defined rule keywords. type: array items: type: string example: test name: description: The policy name. type: string example: the policy name regular_expression: description: >- The regular expression to match to the content of chat messages. type: string example: ^test status: description: |- The policy's current status: * `activated` — Activated. * `deactivated` — Deactivated. enum: - activated - deactivated type: string x-enum-descriptions: - Activated. - Deactivated. example: activated trigger_action: description: >- The policy's trigger action: * `1` — Ask the user to confirm before they send the message. * `2` — Block the user's message. enum: - 1 - 2 type: integer x-enum-descriptions: - >- Ask the user to confirm before they send the message. - Block the user's message. example: 1 embed_password_in_join_link: description: >- Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. type: boolean example: true encryption_type: description: >- The type of encryption to use when starting a meeting: * `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. * `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host. enum: - enhanced_encryption - e2ee type: string example: e2ee end_to_end_encrypted_meetings: description: >- Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field. type: boolean example: true meeting_password: description: >- Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting. type: boolean example: true meeting_password_requirement: description: >- Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604). type: object properties: consecutive_characters_length: description: >- The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: * `4` through `8` — The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the provided value. For example, if you provide the `4` value, there can only be a maximum of `3` consecutive characters in a password (for example, `abc1x@8fdh`). * `0` — Do not apply a consecutive character restriction. enum: - 0 - 4 - 5 - 6 - 7 - 8 type: integer example: 8 have_letter: description: >- Whether the password must contain at least one letter character. type: boolean example: true have_number: description: >- Whether the password must contain at least one numeric character. type: boolean example: true have_special_character: description: >- Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters. type: boolean example: true have_upper_and_lower_characters: description: >- Whether the password must include uppercase and lowercase characters. type: boolean example: true length: description: The password's minimum length. type: integer example: 8 only_allow_numeric: description: >- Whether the password must contain **only** numeric characters. type: boolean example: true weak_enhance_detection: description: >- Whether users will be informed when the provided password is weak. type: boolean example: true only_authenticated_can_join_from_webclient: description: >- Whether to specify that only authenticated users can join the meeting from the web client. type: boolean example: true phone_password: description: >- Whether to require a password for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated. type: boolean example: true pmi_password: description: >- Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. type: boolean example: true require_password_for_scheduled_meeting: description: >- Whether to require a password for meetings that have already been scheduled. type: boolean example: true require_password_for_scheduled_webinar: description: >- Whether to require a password for webinars that have already been scheduled. type: boolean example: true waiting_room: description: >- Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled. type: boolean example: true waiting_room_settings: description: Information about the Waiting Room settings. type: object properties: participants_to_place_in_waiting_room: description: >- The type of participants to be admitted to the Waiting Room: * `0` — All attendees. * `1` — Users who are not in your account. * `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da). enum: - 0 - 1 - 2 type: integer example: 0 users_who_can_admit_participants_from_waiting_room: description: >- The users who can admit participants from the Waiting Room: * `0` — Host and co-hosts only. * `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present. enum: - 0 - 1 type: integer example: 0 whitelisted_domains_for_waiting_room: description: >- If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`"example.com,example2.com"`). type: string example: example2.com webinar_password: description: >- Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar. type: boolean example: true title: Meeting or Webinar Security Account Settings type: object - title: Update Video SDK Account Settings type: object properties: in_meeting: deprecated: true type: object properties: custom_data_center_regions: description: >- Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): * `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. * `false` — Only use the default data center regions. type: boolean example: false data_center_regions: type: array description: >- If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: * `AU` — Australia. * `LA` — Latin America. * `CA` — Canada. * `CN` — China. * `DE` — Germany. * `HK` — Hong Kong SAR. * `IN` — India. * `IE` — Ireland. * `TY` — Japan. * `MX` — Mexico. * `NL` — Netherlands. * `SG` — Singapore. * `US` — United States. items: type: string enum: - AU - LA - CA - CN - DE - HK - IN - IE - TY - MX - NL - SG - US example: US in_session: type: object properties: custom_data_center_regions: description: >- Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): * `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. * `false` — Only use the default data center regions. type: boolean example: false data_center_regions: type: array description: >- If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: * `AU` — Australia. * `LA` — Latin America. * `CA` — Canada. * `CN` — China. * `DE` — Germany. * `HK` — Hong Kong SAR. * `IN` — India. * `IE` — Ireland. * `TY` — Japan. * `MX` — Mexico. * `NL` — Netherlands. * `SG` — Singapore. * `US` — United States. items: type: string enum: - AU - LA - CA - CN - DE - HK - IN - IE - TY - MX - NL - SG - US example: US p2p_connetion: description: >- Whether to enable the [**Peer to Peer connection while only 2 people are in a meeting**](https://support.zoom.us/hc/en-us/articles/360061410851-Enabling-Peer-to-Peer-connection-for-2-people-in-a-meeting) setting. type: boolean example: true p2p_ports: description: Whether to enable the **Listening ports range** setting. type: boolean example: true ports_range: default: '' description: >- When the `p2p_ports` value is `true`, the value is a semi-colon list of the peer to peer listening ports range, between `1` to `65535`. This value defaults to an empty string. type: string example: 1;65535 dscp_audio: default: 56 description: The DSCP audio marking value. This value defaults to `56`. maximum: 63 minimum: 1 type: integer example: 56 dscp_marking: description: >- Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking. type: boolean example: true dscp_video: default: 40 description: The DSCP video marking value. This value defaults to `40`. maximum: 63 minimum: 1 type: integer example: 40 dscp_dual: type: boolean description: >- Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing). example: false subsession: description: >- Allow host to split meeting participants into separate, smaller rooms. type: boolean example: true session_security: type: object properties: approved_or_denied_countries_or_regions: description: > Approve or block users from specific regions or countries from joining this meeting. type: object properties: approved_list: description: >- List of countries/regions from where participants can join this meeting. type: array items: type: string example: CX denied_list: description: >- List of countries/regions from where participants can not join this meeting. type: array items: type: string example: CA enable: description: >- `true`: Setting enabled to either allow or block users from specific regions from joining your meetings. <br> `false`: Setting disabled. type: boolean example: true method: description: >- Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br> `approve`: Allow users from specific regions or countries to join this meeting. If this setting is selected, the approved regions or countries must be included in the `approved_list`.<br><br> `deny`: Block users from specific regions or countries from joining this meeting. If this setting is selected, the approved regions or countries must be included in the `denied_list` enum: - approve - deny type: string example: approve recording: type: object properties: record_speaker_view: type: boolean description: >- Whether to enable the recording of the [**Active Speaker** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_5c001397-33d6-47fb-bb40-1a3f68401581) during screen sharing. example: true record_gallery_view: type: boolean description: >- Whether to enable the recording of the [**Gallery** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_889dc825-9d79-4139-b65d-e719669c546b) during screen sharing. example: false record_audio_file: type: boolean description: Whether to record a single audio file for all participants. example: true save_chat_text: type: boolean description: Whether to save meeting and webinar chat texts. example: false show_timestamp: type: boolean description: Whether to add timestamps to meeting and webinar recordings. example: true cloud_recording_download: type: boolean description: >- Whether to enable the [**Cloud recording downloads**](https://support.zoom.us/hc/en-us/articles/360060240972-Managing-cloud-recording-settings) setting. example: true auto_delete_cmr: type: boolean description: >- Whether to enable the automatic deletion of cloud recordings after a specific number of days. example: true auto_delete_cmr_days: type: integer description: >- When the `auto_delete_cmr` value is `true`, the number of days before Zoom automatically deletes cloud recordings: * `30` — 30 days. * `60` — 60 days. * `90` — 90 days. * `120` — 120 days. enum: - 30 - 60 - 90 - 120 example: 30 title: Data