type: object
properties:
parameters:
type: object
properties:
option:
type: string
enum:
- meeting_authentication
- recording_authentication
- meeting_security
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.
* `meeting_security` — Use this query parameter to view the meeting
security settings applied to the user's account.
groupId:
type: string
example: 0mgThLiRQH2bUHvIaL4t2g
custom_query_fields:
type: string
example: host_video
description: >-
Provide the name of the field by which you would like to filter the
response. For example, if you provide "host_video" as the value of
this field, you will get a response similar to the following:
{
"schedule_meeting": {
"host_video": false
}
}
You can provide multiple values by separating them with
commas(example: "host_video,participant_video").
required:
- groupId
title: Parameters
oneOf:
- properties:
audio_conferencing:
description: The group's audio conference settings.
type: object
properties:
toll_free_and_fee_based_toll_call:
description: >-
The group'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_01F51844DRCX3K7BRTMZ40381R)
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 group 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_01F51844DRCX3K7BRTMZ40381R)
setting enabled.
type: boolean
example: true
numbers:
description: >-
The group'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 7777 777
number:
description: The phone number.
maxLength: 30
type: string
example: 7777 777
email_notification:
type: object
properties:
alternative_host_reminder:
description: Notify the alternative host who is set or removed.
type: boolean
example: true
cancel_meeting_reminder:
description: Notify host and participants when the 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 host when participants join the meeting before them.
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
in_meeting:
type: object
properties:
alert_guest_join:
description: >-
Allow participants who belong to your account to see that a guest
(someone who does not belong to your account) is participating in
the meeting/webinar.
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_live_streaming:
description: Whether livestreaming is enabled.
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
x-enum-descriptions:
- No one
- Host and co-hosts
- Everyone
- Everyone and anyone directly
example: 1
allow_show_zoom_windows:
description: Show Zoom windows during screen share.
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
x-enum-descriptions:
- Not allow
- Host and co-hosts
- Everyone
example: 1
annotation:
description: >-
Allow participants to use annotation tools to add information to
shared screens.
type: boolean
example: true
attendee_on_hold:
default: false
description: |-
Allow host to put attendee on hold.
**This field has been deprecated and is no longer supported.**
type: boolean
example: true
auto_answer:
description: >-
Enable users to see and add contacts to 'auto-answer group' in the
contact list on chat. Any call from members of this group will be
automatically answered.
type: boolean
example: true
auto_saving_chat:
description: Automatically save all in-meeting chats.
type: boolean
example: true
breakout_room:
description: >-
Allow host to split meeting participants into separate, smaller
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: >-
Allow meeting participants to send chat message visible to 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: >-
Allow host to type closed captions or assign a participant/third
party device to add closed captions.
type: boolean
example: true
closed_captioning:
description: Information about the group's closed captioning settings.
type: object
properties:
auto_transcribing:
description: >-
Whether to allow a live transcription service to transcribe
meetings.
type: boolean
example: true
enable:
description: >-
Whether to allow the host to type closed captions or assign a
participant or 3rd-party service to provide closed captioning.
type: boolean
example: true
save_caption:
description: >-
Whether to allow participants to save closed captions or
transcripts.
type: boolean
example: true
third_party_captioning_service:
description: >-
Whether to allow the use of an API token to integrate with
3rd-party closed captioning services.
type: boolean
example: true
view_full_transcript:
description: >-
Whether to allow the viewing of full transcripts in the
in-meeting side panel.
type: boolean
example: true
co_host:
description: >-
Allow the host to add co-hosts. Co-hosts have the same in-meeting
controls as the host.
type: boolean
example: true
custom_data_center_regions:
description: >-
If set to `true`, you can [select data center
regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars)
to be used by this group for hosting their real-time meeting and
webinar traffic. These regions can be provided in the
`data_center_regions` field. If set to `false`, the regions cannot
be customized and the default regions will be used.
type: boolean
example: true
custom_live_streaming_service:
description: Whether custom livestreaming is enabled.
type: boolean
example: true
custom_service_instructions:
description: >-
The specific instructions to allow your account's meeting hosts 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 the **Disable desktop screen sharing for meetings you
host** setting is enabled.
type: boolean
example: true
disable_screen_sharing_for_in_meeting_guests:
description: >-
Whether the **Disable screen sharing when guests are in the
meeting** setting is enabled.
type: boolean
example: true
e2e_encryption:
description: Require that all meetings are encrypted using AES.
type: boolean
example: true
entry_exit_chime:
description: Play sound when participants join or leave.
type: string
example: all
far_end_camera_control:
description: Allow another user to take control of the camera during a meeting.
type: boolean
example: true
feedback:
description: >-
Enable users to provide feedback to Zoom at the end of the
meeting.
type: boolean
example: true
file_transfer:
description: >-
Indicates whether [in-meeting file
transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer)
setting has been enabled for the users in the group or not.
type: boolean
example: true
group_hd:
description: >-
Enable higher quality video for host and participants. This will
require more bandwidth.
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
languages:
description: A list of system-supported languages.
enum:
- English
- Chinese
- Japanese
- German
- French
- Russian
- Portuguese
- Spanish
- Korean
type: array
items:
type: string
example: English
live_streaming_facebook:
description: Whether Facebook livestreaming is enabled.
type: boolean
example: true
live_streaming_youtube:
description: Whether YouTube livestreaming is enabled.
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
non_verbal_feedback:
description: >-
Allow participants in a meeting can provide nonverbal feedback and
express opinions by clicking on icons in the Participants panel.
type: boolean
example: true
only_host_view_device_list:
description: Show the list of H.323/SIP devices only to the host.
type: boolean
example: true
original_audio:
description: Allow users to select original sound during a meeting.
type: boolean
example: true
polling:
description: >-
Add 'Polls' to the meeting controls. This allows the host to
survey the attendees.
type: boolean
example: true
post_meeting_feedback:
description: Display end-of-meeting experience feedback survey.
type: boolean
example: true
private_chat:
description: >-
Allow meeting participants to send a private 1:1 message to
another participant.
type: boolean
example: true
record_play_own_voice:
description: >-
When each participant joins by telephone, allow the option to
record and play their own voice as entry and exit chimes.
type: boolean
example: true
remote_control:
description: >-
During screen sharing, allow the person who is sharing to let
others control the shared content.
type: boolean
example: true
remote_support:
description: >-
Allow meeting host to provide 1:1 remote support to another
participant.
type: boolean
example: true
request_permission_to_unmute:
description: >-
Indicates whether the [**Request permission to unmute
participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260)
option has been enabled for the group or not.
type: boolean
example: true
screen_sharing:
description: >-
Allow host and participants to share their screen or content
during meetings.
type: boolean
example: true
sending_default_email_invites:
description: Allow users to invite participants by email only by default.
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_browser_join_link:
description: Allow participants to join a meeting directly from their browser.
type: boolean
example: true
show_device_list:
description: Show the list of H.323/SIP devices.
type: boolean
example: true
show_meeting_control_toolbar:
description: Always show meeting controls during a meeting.
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: Allow users to select stereo audio during a meeting.
type: boolean
example: true
unchecked_data_center_regions:
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 **not** opt in to:
* `EU` — Europe.
* `HK` — Hong Kong.
* `AU` — Australia.
* `IN` — India.
* `LA` — Latin America.
* `TY` — Tokyo.
* `CN` — China.
* `US` — United States.
* `CA` — Canada.
enum:
- EU
- HK
- AU
- IN
- TY
- CN
- US
- CA
- DE
- NL
- LA
type: array
items:
type: string
example: EU
use_html_format_email:
description: >-
Allow HTML formatting instead of plain text for meeting
invitations scheduled with the Outlook plugin.
type: boolean
example: true
virtual_background:
description: Enable virtual background.
type: boolean
example: true
virtual_background_settings:
description: Settings to manage virtual background.
type: object
properties:
allow_upload_custom:
description: Allow users to upload custom backgrounds.
type: boolean
example: true
allow_videos:
description: Allow use of videos for virtual backgrounds.
type: boolean
example: true
enable:
description: Enable virtual background.
type: boolean
example: true
files:
type: array
items:
type: object
properties:
id:
description: Unique identifier of the file.
type: string
example: fawegw4tq43t35h4nhgfnethswe
is_default:
description: >-
Indicates whether or not this file is the default
virtual background file.
type: boolean
example: true
name:
description: File name.
type: string
example: File name
size:
description: File size.
type: integer
example: 1435
type:
description: File type.
type: string
example: image
waiting_room:
description: >-
Attendees cannot join a meeting until a host admits them
individually from the waiting room.
type: boolean
example: true
webinar_chat:
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: 2
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: 0
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 your account's meeting
hosts to configure a custom livestream.
type: string
example: The specific instructions test
enable:
description: Whether webinar livestreaming is enabled.
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`
* `workplace_by_facebook`
* `youtube`
* `custom_live_streaming_service`
type: array
items:
enum:
- facebook
- workplace_by_facebook
- youtube
- custom_live_streaming_service
type: string
x-enum-descriptions:
- Facebook
- Workplace by Facebook
- YouTube
- Custom Live Streaming Service
example: facebook
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 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
manage_saved_polls_and_quizzes:
description: >-
Whether to allow users to manage saved polls and quizzes from
Meetings
type: boolean
example: true
require_answers_to_be_anonymous:
description: Whether to require answers to be anonymous.
type: boolean
example: true
allow_alternative_host_to_add_edit:
type: boolean
description: >-
Whether to allow alternative hosts 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_polling:
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 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
manage_saved_polls_and_quizzes:
description: >-
Whether to allow users to manage saved polls and quizzes from
Meetings
type: boolean
example: true
require_answers_to_be_anonymous:
description: Whether to require answers to be anonymous.
type: boolean
example: true
allow_host_to_upload_image:
description: Whether to allow host to upload an image for each question.
type: boolean
example: true
allow_alternative_host_to_add_edit:
type: boolean
description: >-
Whether to allow alternative hosts to add or edit polls and
quizzes.
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: >-
Allow participants to share a whiteboard that includes annotation
tools.
type: boolean
example: true
who_can_share_screen:
description: >
Indicates who can share their screen or content during meetings.
The value can be one of the following: <br>
`host`: Only host can share the screen.<br>
`all`: Both hosts and attendees can share their screen during
meetings. For Webinar, the hosts and panelists can start screen
sharing, but not the attendees.
enum:
- host
- all
type: string
example: host
who_can_share_screen_when_someone_is_sharing:
description: >
Indicates who is allowed to start sharing screen when someone else
in the meeting is sharing their screen. The value can be one of
the following:<br>
`host`: Only a host can share the screen when someone else is
sharing.<br>
`all`: Anyone in the meeting is allowed to start sharing their
screen when someone else is sharing. For Webinar, the hosts and
panelists can start screen sharing, but not the attendees.
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)
. For Webinar, the hosts and panelists can start screen sharing,
but not the attendees.
enum:
- multiple
- one
type: string
example: multiple
workplace_by_facebook:
description: Whether Workplace by Facebook is enabled.
type: boolean
example: true
other_options:
type: object
properties:
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
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
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:
type: object
properties:
account_user_access_recording:
description: Make cloud recordings accessible to account members only.
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
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: 2
auto_recording:
description: Record meetings automatically as they start.
type: string
example: local
cloud_recording:
description: Allow hosts to record and save the meeting / webinar in the cloud.
type: boolean
example: true
cloud_recording_download:
description: Allow anyone with a link to the cloud recording to download.
type: boolean
example: true
cloud_recording_download_host:
description: >-
Allow only the host with a link to the cloud recording to
download.
type: boolean
example: true
host_delete_cloud_recording:
description: >-
Allow the host to delete the recordings. If this option is
disabled, the recordings cannot be deleted by the host and only
admin can delete them.
type: boolean
example: true
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 recording only the active speaker is enabled.
example: true
gallery_view:
type: boolean
description: Whether recording only the gallery view is enabled.
example: true
shared_screen:
type: boolean
description: Whether recording only shared screen is enabled.
example: true
display_participant_name:
type: boolean
description: Whether participants' names display in the recording.
example: true
recording_thumbnails:
type: boolean
description: >-
Whether thumbnails of the presenter are recorded when they are
sharing their screen.
example: true
optimize_recording_for_3rd_party_video_editor:
description: >-
Whether recordings will be optimized for a 3rd party video editor.
This can increase the file size and the time it takes to generate
recording files.
type: boolean
example: true
recording_highlight:
description: >-
Whether the [recording
highlights](https://support.zoom.us/hc/en-us/articles/360060802432)
feature is enabled.
type: boolean
example: true
save_panelist_chat:
description: Whether panelist chats are saved to the recording.
type: boolean
example: true
save_poll_results:
description: >-
Whether poll results shared during the meeting or webinar are
saved. This also includes poll results shared during the meeting
or webinar.
type: boolean
example: true
save_close_caption:
description: >-
Whether [closed
captions](https://support.zoom.us/hc/en-us/articles/207279736) are
saved as a VTT (Video Track Text) file.
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: 200.181.108.17 - 220.181.108.157
local_recording:
description: >-
Allow hosts and participants to record the meeting to 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: >-
When someone is sharing their screen, active speaker will show on
the top right corner of the shared screen.
type: boolean
example: true
record_speaker_view:
description: Record active speaker with shared screen.
type: boolean
example: true
recording_audio_transcript:
description: >-
Automatically transcribe the audio of a meeting or webinar for
cloud recordings.
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
save_chat_text:
description: Save chat messages from the meeting / webinar.
type: boolean
example: true
show_timestamp:
description: Add a timestamp to the recording.
type: boolean
example: true
schedule_meeting:
type: object
properties:
audio_type:
description: >-
Determine how participants can join the audio portion of the
meeting.
type: string
example: both
embed_password_in_join_link:
description: >-
If the value is set to `true`, the meeting password will be
encrypted and included in the join meeting link to allow
participants to join with just one click without having to enter
the password.
type: boolean
example: true
force_pmi_jbh_password:
deprecated: true
description: >+
If join before host option is enabled for a personal meeting, then
enforce password requirement.
**This field will be deprecated in near future.** If you would
like to enable this setting, we highly encourage you to use the
`require_password_for_pmi_meetings` field.
type: boolean
example: true
host_video:
description: Start meetings with host video on.
type: boolean
example: true
join_before_host:
description: Allow participants to join the meeting before the host arrives
type: boolean
example: true
mute_upon_entry:
description: Automatically mute all participants when they join the meeting.
type: boolean
example: true
participant_video:
description: Start meetings with participant video on.
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 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
pstn_password_protected:
description: >-
Generate and send new passwords for newly scheduled or edited
meetings.
type: boolean
example: true
require_password_for_instant_meetings:
description: >-
If enabled, a random password will be generated on the user's end
who starts the instant meeting. Other participants will have to
enter the password to join the meeting. If you use PMI for your
instant meetings, this option will be disabled.
type: boolean
example: true
require_password_for_pmi_meetings:
description: >-
Indicates whether a password is required for
[PMI](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-)
meetings or not. The value can be one of the following:<br>
`none`: Do not require password for PMI meetings.<br>
`all`: Require participants to enter password for all PMI enabled
meetings.<br> `jbh_only`: Require password only for meetings where
the **"join before host"** setting is enabled.
enum:
- all
- jbh_only
- none
type: string
example: jbh_only
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: >-
This setting applies for regular meetings that do not use 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.
type: boolean
example: true
upcoming_meeting_reminder:
description: Receive desktop notification for upcoming meetings.
type: boolean
example: true
use_pmi_for_instant_meetings:
description: Indicates whether PMI is enabled for all instant meetings or not.
type: boolean
example: true
use_pmi_for_schedule_meetings:
description: >-
Indicates whether PMI is enabled for all scheduled meetings or
not.
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:
description: >-
Whether the **Always display "Zoom Meeting" as the meeting
topic** setting is enabled.
type: boolean
example: false
display_topic_for_scheduled_meetings:
description: >-
Whether to display "Zoom Meeting" as the topic for
already-scheduled meetings.
type: boolean
example: false
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:
description: >-
Whether the **Always show "Zoom Webinar" as the webinar
topic** setting is enabled.
type: boolean
example: false
display_topic_for_scheduled_webinars:
description: >-
Whether to display "Zoom Webinar" as the topic for
already-scheduled meetings.
type: boolean
example: false
telephony:
type: object
properties:
audio_conference_info:
description: ''
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: CNTB
third_party_audio:
description: >-
Allow users to join the meeting using the existing 3rd party audio
configuration.
type: boolean
example: true
chat:
type: object
description: The account's chat settings.
properties:
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
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
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_search_others_options:
description: >-
Allow users to search others, when selecting multiple items,
separate them with commas.
* ''-none.
* '1' — In the same account.
* '2' — Under the same master account, including all sub acounts.
* '3' — Under the same organization.
type: string
example: 1,3
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 domains or emails (internal or external).
* 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 domains or emails (internal or external).
* 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:
description: Whether the **Chat Etiquette Tool** is enabled.
type: boolean
example: true
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: dvgerwe98z8v9vgbug43iubkjn
is_locked:
description: >-
Whether the policy is locked by an account-level user.
When it is locked, users cannot update the policy.
type: boolean
example: true
keywords:
description: A list of defined rule keywords.
type: array
items:
type: string
example: key
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: 2
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: object
- oneOf:
- properties:
allow_authentication_exception:
description: >-
Whether the [**Allow authentication
exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY)
setting is enabled. This lets hosts invite users who can bypass
authentication.
type: boolean
example: true
authentication_options:
description: Meeting Authentication Options
type: array
items:
type: object
properties:
default_option:
description: Authentication default option
type: boolean
example: true
domains:
description: Authentication domains
type: string
example: example.com
id:
description: Authentication id
type: string
example: ewf22f42fewf4232fgg4343lki4
name:
description: Authentication name
type: string
example: Authentication 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
visible:
description: Authentication visible
type: boolean
example: true
meeting_authentication:
description: Only authenticated users can join meetings
type: boolean
example: true
type: object
- properties:
authentication_options:
description: Authentication Options
type: array
items:
type: object
properties:
default_option:
description: Authentication default option
type: boolean
example: true
domains:
description: Authentication domains
type: string
example: example.com
id:
description: Authentication id
type: string
example: ewf22f42fewf4232fgg4343lki4
name:
description: Authentication name
type: string
example: Authentication name
type:
description: Authentication type
enum:
- internally
- enforce_login
- enforce_login_with_domains
type: string
example: enforce_login_with_domains
visible:
description: Authentication visible
type: boolean
example: true
recording_authentication:
description: Only authenticated users can view cloud recordings
type: boolean
example: true
type: object
type: object
- description: The group's meeting and webinar security settings.
properties:
meeting_security:
type: object
properties:
auto_security:
description: >-
Whether all meetings are required to be 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 users in specific domains are blocked from joining
meetings and webinars.
type: boolean
example: true
block_user_domain_list:
description: A list of blocked domains.
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:
description: Whether the **Chat Etiquette Tool** is enabled.
type: boolean
example: true
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: dvgerwe98z8v9vgbug43iubkjn
is_locked:
description: >-
Whether the policy is locked by an account-level user.
When it is locked, users cannot update the policy.
type: boolean
example: true
keywords:
description: A list of defined rule keywords.
type: array
items:
type: string
example: key
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: 2
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 used to start a meeting:
* `enhanced_encryption` — 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. 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: enhanced_encryption
end_to_end_encrypted_meetings:
description: Whether end-to-end encryption is enabled for meetings.
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: 10
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 a password is required 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 a password is required for meetings that have already been
scheduled.
type: boolean
example: true
require_password_for_scheduled_webinar:
description: >-
Whether a password is required 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.
When 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 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: 1
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: example.com
webinar_password:
description: >-
Whether a password is generated when scheduling webinars.
Participants must use the generated password to join the scheduled
webinar.
type: boolean
example: true
title: Meeting/Webinar Security Group Settings
type: object