Users
- OpenAPI Version:
3.1.0 - API Version:
1.0.0
The User webhooks allow developers to receive events related to users and groups.
Operations
POST group.admin_added
- Method:
POST - Path:
group.admin_added - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
admins(required)array— Information about the group administrators.Items:
-
emailstring, format:email— The admin's email address. -
idstring— The administrator's user ID.
-
-
id(required)string— The group ID.
-
-
operator(required)string, format:email— The email address of the user that added the admin to the group. -
operator_id(required)string— The user ID of the user that added the admin to the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's admin were added, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"admins": [
{
"id": "",
"email": ""
}
]
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
admins(required)array— Information about the group administrators.Items:
-
emailstring, format:email— The admin's email address. -
idstring— The administrator's user ID.
-
-
id(required)string— The group ID.
-
-
operator(required)string, format:email— The email address of the user that added the admin to the group. -
operator_id(required)string— The user ID of the user that added the admin to the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's admin were added, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"admins": [
{
"id": "",
"email": ""
}
]
}
}
}
POST group.lock_settings_updated
- Method:
POST - Path:
group.lock_settings_updated - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the group's settings. -
object(required)object— Information about the group's updated settings.-
id(required)string— The updated group's ID. -
settings(required)object-
audio_conferencingobject— Group Audio Conference Settings-
call_me_and_invite_by_phoneboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
participant_phone_maskingboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
toll_free_and_fee_based_toll_callboolean— 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) setting enabled.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
schedule_for_reminderboolean— Whether the host is notified if a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_generated_captionsboolean— Whether live transcription services are available to transcribe meetings. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
group_hdboolean— Whether a higher quality video for host and participants is enabled. This will require more bandwidth. -
language_interpretationboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
manual_captionsboolean— Whether hosts can type closed captions or assign a participant/third party device to add closed captions. -
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
save_captionsboolean— Whether participants can save closed captions or transcripts. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_browser_join_linkboolean— Whether participants can join a meeting directly from their browser. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationboolean— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later. -
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatboolean— Whether webinar participants can send chat messages. -
webinar_live_streamingboolean— Whether webinar livestreaming is enabled. -
webinar_pollingboolean— Whether the host can add polls before or during a webinar. -
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools.
-
-
meeting_securityobject-
approved_or_denied_countries_or_regionsboolean— Whether the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting is enabled. -
auto_securityboolean— Whether all meetings must 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— Whether passwords are required for participants joining by phone. If this setting is 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
waiting_roomboolean— 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. -
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar.
-
-
other_optionsobject-
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveboolean— [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. -
auto_delete_cmrboolean— Whether Zoom automatically deletes recordings permanently after a specified number of days. -
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
prevent_host_access_recordingboolean— Whether hosts can access and view their meetings' cloud recordings. -
recording_authenticationboolean— Whether only authenticated users can view cloud recordings.
-
-
schedule_meetingobject-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
meeting_authenticationboolean— Whether only authenticated users can join meetings. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsboolean— Whether participants are required to enter a password for PMI meetings. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. All participants must enter the password before they can join the meeting. This only applies to meetings that do not use a PMI. -
upcoming_meeting_reminderboolean— Whether desktop notifications for upcoming meetings is enabled.
-
-
telephonyobject— Group Settings: Telephony.-
telephony_regionsboolean— Whether telephony regions are enabled for meetings. -
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
operator(required)string, format:email— The email address of the user that updated the group's settings. -
operator_id(required)string— The user ID of the user that updated the group's settings. -
old_objectobject— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
settings(required)object— Information about the group's previous settings. This only returns modified settings.-
audio_conferencingobject— The group's Audio Conference settings.-
call_me_and_invite_by_phoneboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
participant_phone_maskingboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
toll_free_and_fee_based_toll_callboolean— 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) setting enabled.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
schedule_for_reminderboolean— Whether the host is notified if a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_generated_captionsboolean— Whether live transcription services are available to transcribe meetings. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
group_hdboolean— Whether a higher quality video for host and participants is enabled. This will require more bandwidth. -
language_interpretationboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
manual_captionsboolean— Whether hosts can type closed captions or assign a participant/third party device to add closed captions. -
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
save_captionsboolean— Whether participants can save closed captions or transcripts. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_browser_join_linkboolean— Whether participants can join a meeting directly from their browser. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationboolean— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later. -
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatboolean— Whether webinar participants can send chat messages. -
webinar_live_streamingboolean— Whether webinar livestreaming is enabled. -
webinar_pollingboolean— Whether the host can add polls before or during a webinar. -
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools.
-
-
meeting_securityobject-
approved_or_denied_countries_or_regionsboolean— Whether the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting is enabled. -
auto_securityboolean— Whether all meetings must 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— Whether passwords are required for participants joining by phone. If this setting is 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
waiting_roomboolean— 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. -
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar.
-
-
other_optionsobject-
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveboolean— [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. -
auto_delete_cmrboolean— Whether Zoom automatically deletes recordings permanently after a specified number of days. -
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
prevent_host_access_recordingboolean— Whether hosts can access and view their meetings' cloud recordings. -
recording_authenticationboolean— Whether only authenticated users can view cloud recordings.
-
-
schedule_meetingobject-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
meeting_authenticationboolean— Whether only authenticated users can join meetings. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsboolean— Whether participants are required to enter a password for PMI meetings. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. All participants must enter the password before they can join the meeting. This only applies to meetings that do not use a PMI. -
upcoming_meeting_reminderboolean— Whether desktop notifications for upcoming meetings is enabled.
-
-
telephonyobject— Group Settings: Telephony.-
telephony_regionsboolean— Whether telephony regions are enabled for meetings. -
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
time_stampinteger, format:int64— A timestamp that indicates when the group's settings were updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_browser_join_link": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"waiting_room": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"other_options": {
"blur_snapshot": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"prevent_host_access_recording": true,
"recording_authentication": true,
"archive": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"mute_upon_entry": true,
"participant_video": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_browser_join_link": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"waiting_room": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"other_options": {
"blur_snapshot": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"prevent_host_access_recording": true,
"recording_authentication": true,
"archive": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"mute_upon_entry": true,
"participant_video": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
}
}
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the group's settings. -
object(required)object— Information about the group's updated settings.-
id(required)string— The updated group's ID. -
settings(required)object-
audio_conferencingobject— Group Audio Conference Settings-
call_me_and_invite_by_phoneboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
participant_phone_maskingboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
toll_free_and_fee_based_toll_callboolean— 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) setting enabled.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
schedule_for_reminderboolean— Whether the host is notified if a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_generated_captionsboolean— Whether live transcription services are available to transcribe meetings. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
group_hdboolean— Whether a higher quality video for host and participants is enabled. This will require more bandwidth. -
language_interpretationboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
manual_captionsboolean— Whether hosts can type closed captions or assign a participant/third party device to add closed captions. -
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
save_captionsboolean— Whether participants can save closed captions or transcripts. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_browser_join_linkboolean— Whether participants can join a meeting directly from their browser. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationboolean— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later. -
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatboolean— Whether webinar participants can send chat messages. -
webinar_live_streamingboolean— Whether webinar livestreaming is enabled. -
webinar_pollingboolean— Whether the host can add polls before or during a webinar. -
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools.
-
-
meeting_securityobject-
approved_or_denied_countries_or_regionsboolean— Whether the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting is enabled. -
auto_securityboolean— Whether all meetings must 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— Whether passwords are required for participants joining by phone. If this setting is 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
waiting_roomboolean— 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. -
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar.
-
-
other_optionsobject-
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveboolean— [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. -
auto_delete_cmrboolean— Whether Zoom automatically deletes recordings permanently after a specified number of days. -
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
prevent_host_access_recordingboolean— Whether hosts can access and view their meetings' cloud recordings. -
recording_authenticationboolean— Whether only authenticated users can view cloud recordings.
-
-
schedule_meetingobject-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
meeting_authenticationboolean— Whether only authenticated users can join meetings. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsboolean— Whether participants are required to enter a password for PMI meetings. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. All participants must enter the password before they can join the meeting. This only applies to meetings that do not use a PMI. -
upcoming_meeting_reminderboolean— Whether desktop notifications for upcoming meetings is enabled.
-
-
telephonyobject— Group Settings: Telephony.-
telephony_regionsboolean— Whether telephony regions are enabled for meetings. -
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
operator(required)string, format:email— The email address of the user that updated the group's settings. -
operator_id(required)string— The user ID of the user that updated the group's settings. -
old_objectobject— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
settings(required)object— Information about the group's previous settings. This only returns modified settings.-
audio_conferencingobject— The group's Audio Conference settings.-
call_me_and_invite_by_phoneboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
participant_phone_maskingboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
toll_free_and_fee_based_toll_callboolean— 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) setting enabled.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
schedule_for_reminderboolean— Whether the host is notified if a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_generated_captionsboolean— Whether live transcription services are available to transcribe meetings. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
group_hdboolean— Whether a higher quality video for host and participants is enabled. This will require more bandwidth. -
language_interpretationboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
manual_captionsboolean— Whether hosts can type closed captions or assign a participant/third party device to add closed captions. -
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
save_captionsboolean— Whether participants can save closed captions or transcripts. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_browser_join_linkboolean— Whether participants can join a meeting directly from their browser. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationboolean— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later. -
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatboolean— Whether webinar participants can send chat messages. -
webinar_live_streamingboolean— Whether webinar livestreaming is enabled. -
webinar_pollingboolean— Whether the host can add polls before or during a webinar. -
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools.
-
-
meeting_securityobject-
approved_or_denied_countries_or_regionsboolean— Whether the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting is enabled. -
auto_securityboolean— Whether all meetings must 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— Whether passwords are required for participants joining by phone. If this setting is 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
waiting_roomboolean— 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. -
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar.
-
-
other_optionsobject-
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveboolean— [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. -
auto_delete_cmrboolean— Whether Zoom automatically deletes recordings permanently after a specified number of days. -
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
prevent_host_access_recordingboolean— Whether hosts can access and view their meetings' cloud recordings. -
recording_authenticationboolean— Whether only authenticated users can view cloud recordings.
-
-
schedule_meetingobject-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
meeting_authenticationboolean— Whether only authenticated users can join meetings. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsboolean— Whether participants are required to enter a password for PMI meetings. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. All participants must enter the password before they can join the meeting. This only applies to meetings that do not use a PMI. -
upcoming_meeting_reminderboolean— Whether desktop notifications for upcoming meetings is enabled.
-
-
telephonyobject— Group Settings: Telephony.-
telephony_regionsboolean— Whether telephony regions are enabled for meetings. -
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
time_stampinteger, format:int64— A timestamp that indicates when the group's settings were updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_browser_join_link": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"waiting_room": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"other_options": {
"blur_snapshot": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"prevent_host_access_recording": true,
"recording_authentication": true,
"archive": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"mute_upon_entry": true,
"participant_video": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_browser_join_link": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"waiting_room": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"other_options": {
"blur_snapshot": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"prevent_host_access_recording": true,
"recording_authentication": true,
"archive": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"mute_upon_entry": true,
"participant_video": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
}
}
}
}
}
POST group.admin_deleted
- Method:
POST - Path:
group.admin_deleted - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
admins(required)array— Information about the group admins.Items:
-
emailstring, format:email— The admin's email address. -
idstring— The admins's user ID.
-
-
id(required)string— The group ID.
-
-
operator(required)string, format:email— The email address of the user that removed the admin from the group. -
operator_id(required)string— The user ID of the user that removed the admin from the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's admin were deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"admins": [
{
"id": "",
"email": ""
}
]
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
admins(required)array— Information about the group admins.Items:
-
emailstring, format:email— The admin's email address. -
idstring— The admins's user ID.
-
-
id(required)string— The group ID.
-
-
operator(required)string, format:email— The email address of the user that removed the admin from the group. -
operator_id(required)string— The user ID of the user that removed the admin from the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's admin were deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"admins": [
{
"id": "",
"email": ""
}
]
}
}
}
POST group.member_deleted
- Method:
POST - Path:
group.member_deleted - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
members(required)array— Information about the members removed from the group.Items:
-
emailstring, format:email— The member's email address. -
idstring— The member's user ID.
-
-
-
operator(required)string, format:email— The email address of the user that removed members from the group. -
operator_id(required)string— The user ID of the user that removed members from the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's members were deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"members": [
{
"id": "",
"email": ""
}
]
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
members(required)array— Information about the members removed from the group.Items:
-
emailstring, format:email— The member's email address. -
idstring— The member's user ID.
-
-
-
operator(required)string, format:email— The email address of the user that removed members from the group. -
operator_id(required)string— The user ID of the user that removed members from the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's members were deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"members": [
{
"id": "",
"email": ""
}
]
}
}
}
POST user.deleted
- Method:
POST - Path:
user.deleted - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was deleted. -
object(required)object— Information about the deleted user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
operator(required)string, format:email— The email address of the user that deleted the user. -
operator_id(required)string— The user ID of the user that deleted the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was deleted. -
object(required)object— Information about the deleted user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
operator(required)string, format:email— The email address of the user that deleted the user. -
operator_id(required)string— The user ID of the user that deleted the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
POST user.deactivated
- Method:
POST - Path:
user.deactivated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was deactivated. -
object(required)object— Information about the deactivated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that deactivated the user. -
operator_id(required)string— The user ID of the user that deactivated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was deactivated. -
object(required)object— Information about the deactivated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that deactivated the user. -
operator_id(required)string— The user ID of the user that deactivated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
POST user.settings_updated
- Method:
POST - Path:
user.settings_updated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The event's name. -
event_ts(required)integer, format:int64— A timestamp, in milliseconds since epoch, at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account that updated the settings. -
object(required)object— Information about the user.-
id(required)string— The modified user's unique ID (userId). -
settings(required)object-
audio_conferencingobject— Information about the audio conferencing settings.-
participant_phone_maskingobject— Information about the participant phone masking settings.-
enableboolean— Whether to mask phone numbers of users dialing into a meeting in the participant list. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
-
email_notificationobject— Information about the email notification settings.-
alternative_host_reminderboolean— Whether to notify when an alternative host is added to or removed from a meeting. -
cancel_meeting_reminderboolean— Whether to notify the host and participants when a meeting is canceled. -
cloud_recording_available_reminderboolean— Whether to notify the host when a cloud recording is available. -
jbh_reminderboolean— Whether to notify the host when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
-
-
featureobject— Information about the features available to the user.-
cn_meetingboolean— Host meeting in China. -
concurrent_meetingstring, possible values:"Basic", "Plus", "None"— The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: * Basic * Plus * None **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription. -
in_meetingboolean— Host meeting in India. -
large_meetingboolean— Whether the large meeting feature is enabled. -
large_meeting_capacityinteger, possible values:500, 1000— The capacity for the user's large meetings: * 500 * 1000 -
meeting_capacityinteger— The user's meeting capacity. -
webinarboolean— Whether the user has the Webinar feature. -
webinar_capacityinteger, possible values:100, 500, 1000, 3000, 5000, 10000— If the user has a Webinar capacity plan subscription, the user's Webinar capacity: * 100 * 500 * 1000 * 3000 * 5000 * 10000 -
zoom_eventsboolean— Whether the user has the Zoom Events feature. -
zoom_events_capacityinteger, possible values:500, 1000, 3000, 5000, 10000, 20000, 30000, 50000— If the user has the Zoom Events feature, the user's Zoom Events plan capacity: * 500 * 1000 * 3000 * 5000 * 10000 * 20000 * 30000 * 50000 -
zoom_phoneboolean— Whether the Zoom Phone feature is enabled.
-
-
in_meetingobject— Information about the in meeting settings.-
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_host_to_enable_focus_modeboolean— Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting. -
allow_live_streamingboolean— Whether to allow livestreaming. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can chat with certain groups: * 1 — The participants cannot use chat. * 2 — Host and co-hosts only. * 3 — The participants can chat with other participants publicly. * 4 - The participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether participants can use annotation tools to add information to shared screens. -
attendee_on_holdboolean— Whether hosts can temporarily remove an attendee from a meeting. -
attention_mode_focus_modeboolean— Whether the [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. -
auto_answerboolean— Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled. -
auto_saving_chatboolean— Whether to automatically save all in-meeting chats. -
breakout_roomboolean— Whether the host can split meeting participants into separate, smaller rooms. -
breakout_room_scheduleboolean— Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400). -
closed_captionboolean— Whether closed captions are enabled. -
closed_captioningobject— Information about the closed captioning settings.-
auto_transcribingboolean— Whether to allow a live transcription service to transcribe meetings. -
enableboolean— Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning. -
save_captionboolean— Whether to allow participants to save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether to allow the use of an API token to integrate with 3rd-party closed captioning services. -
view_full_transcriptboolean— Whether to allow the viewing of full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether to allow the meeting host to add co-hosts. -
custom_data_center_regionsboolean— Whether custom [data center regions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060026) are enabled for hosting real-time meeting and webinar traffic: * true — Enabled. Provide the data center regions in the data_center_regions field. * false — Disabled. Only use the default data center regions. -
custom_live_streaming_serviceboolean— Whether to allow custom livestreaming. -
custom_service_instructionsstring— The custom livestreaming service instructions. -
data_center_regionsarray— The user's selected custom data center regions. This field only returns if the custom_data_center_regions value is true: * 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the **Disable desktop screen sharing for meetings you host** setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings. -
entry_exit_chimestring— The sound that plays when participants join or leave the meeting: * host — Chime when host joins or leaves a meeting. * all — Chime when any participant joins or leaves a meeting. * none — Do not chime. -
far_end_camera_controlboolean— Whether another user can take control of camera during a meeting. -
feedbackboolean— Whether users can send feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether file sharing via in-meeting chat is enabled. -
group_hdboolean— Whether group HD video is enabled. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings.-
custom_languagesarray, default:null— A list of user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters to interpret one language into another in real-time. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether to allow Facebook livestreaming. -
live_streaming_youtubeboolean— Whether to allow YouTube livestreaming. -
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323) located in the **Reactions** menu in the meeting toolbar. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— 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. -
non_verbal_feedbackboolean— Whether non-verbal feedback through screensharing is enabled. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether polls are available in the meeting controls. -
post_meeting_feedbackboolean— Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. -
private_chatboolean— Whether meeting participants can use private chat. -
record_play_voiceboolean— When a participant joins by telephone, whether recording and playing the participant's own voice is enabled. -
remote_controlboolean— Whether users can request remote control. -
remote_supportboolean— Whether the host can provide 1:1 remote support to a participant. -
screen_sharingboolean— Whether to allow hosts and participants to share their screen or content during meetings. -
share_dual_cameraboolean— Share dual camera. This field is **deprecated**. -
show_a_join_from_your_browser_linkboolean— Whether participants can join a meeting directly from their browser and bypass the Zoom application download process. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
virtual_backgroundboolean— Whether users can change their background. -
virtual_background_settingsobject— Information about the virtual background settings.-
allow_upload_customboolean— Whether users can upload custom backgrounds. -
allow_videosboolean— Whether the use of videos for virtual backgrounds is enabled. -
enableboolean— Whether virtual backgrounds are enabled. -
filesarray— Information about virtual background files.Items:
-
idstring— The file's unique ID. -
is_defaultboolean— Whether the file is the default virtual background file. -
namestring— The file's name. -
sizeinteger— The file' size. -
typestring— The file's type.
-
-
-
waiting_roomboolean— Whether the [Waiting Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) feature is enabled. When enabled, attendees can only join after the host approves their entry. -
webinar_chatobject— Whether webinar participants can send chat messages.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— Webinar attendees can chat with: * 1 — No one. * 2 — Host and all panelists. * 3 — Everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— Webinar panelists can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether webinar participants can send chat messages.
-
-
webinar_live_streamingobject— Whether webinar livestreaming is enabled.-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject— Information about the account's webinar polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395). -
webinar_surveyboolean— Whether to allow the host to present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature. -
who_can_share_screenstring, possible values:"host", "all"— 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. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— 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. -
workplace_by_facebookboolean— Whether to allow Workplace by Facebook livestreaming.
-
-
meeting_securityobject— Whether to require that all meetings are secured with at least one security option.-
auto_securityboolean— 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. -
block_user_domainboolean— Whether to block users in specific domains from joining meetings and webinars. -
block_user_domain_listarray— The domain to block, up to 20 domains. For example, the *.example.com domain.Items:
string -
embed_password_in_join_linkboolean— 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. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0065408), such as cloud recording, live streaming, and allowing participants to join before the host. -
end_to_end_encrypted_meetingsboolean— Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the encryption_type field. -
meeting_passwordboolean— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting. -
meeting_password_requirementobject— Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether to specify that only authenticated users can join the meeting from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether to require a password for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether to require a password for webinars that have already been scheduled. -
waiting_roomboolean— Whether participants are placed in the [**Waiting Room**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) when they join a meeting. If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060501) setting is automatically disabled. -
waiting_room_settingsobject— Information about the waiting room settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0061263). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— 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").
-
-
webinar_passwordboolean— Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
recordingobject— Information about recording settings.-
ask_host_to_confirm_disclaimerboolean— Whether to ask the host to confirm the recording disclaimer is enabled. -
ask_participants_to_consent_disclaimerboolean— Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the recording_disclaimer field is set to true. -
auto_delete_cmrboolean— Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the auto_delete_cmr_days field. -
auto_delete_cmr_daysinteger, possible values:30, 60, 90, 120— 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. -
auto_recordingstring, possible values:"local", "cloud", "none"— The automatic recording setting: * local — Record locally * cloud — Record on the cloud. * none — Disabled. -
cloud_recordingboolean— Whether hosts can record and save the meeting or webinar in the cloud. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_pause_stop_recordingboolean— Whether the meeting's host can pause or stop the cloud's auto recording is enabled. -
ip_address_access_controlobject— Information about the settings to allow cloud recording access only from specific IP address ranges.-
enableboolean— Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the ip_addresses_or_ranges property. -
ip_addresses_or_rangesstring— The IP addresses or ranges that have access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record the meeting using a local file. -
optimize_recording_for_3rd_party_video_editorboolean— 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. -
record_audio_fileboolean— Whether recording an audio-only file is enabled. -
record_audio_file_each_participantboolean— Whether to record separate audio files for each participant is enabled. -
record_files_separatelyobject— The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676) settings.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether recording the [gallery view](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062314) with a shared screen is enabled. -
record_speaker_viewboolean— Whether recording the active speaker with a shared screen is enabled. -
recording_audio_transcriptboolean— Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled. -
recording_disclaimerboolean— Whether to display a disclaimer to participants before a recording begins is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled. -
recording_password_requirementobject— Information about the minimum password requirements for recordings via the Account Recording settings.-
have_letterboolean— Whether the password must contain at least one alphabetical letter. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character (for example, !, @, or #). -
lengthinteger— The password's minimum required length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters.
-
-
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether saving the chat text from the meeting to the cloud is enabled. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062490) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether adding a timestamp to the recording is enabled.
-
-
schedule_meetingobject— Information about the scheduled meeting settings.-
audio_typestring— The type of audio used to join the meeting. -
default_password_for_scheduled_meetingsboolean— Whether to use the default password for already scheduled meetings. -
force_pmi_jbh_passwordstring— Whether to require a password for personal meetings if attendees can join before host. -
host_videoboolean— Whether to start meetings with the host video on. -
jbh_timeinteger, possible values:0, 5, 10, 15— If the value of the join_before_host field is true, this field indicates the time limits within which a participant can join a meeting before the meeting's host: * 0 — Allow the participant to join the meeting at anytime. * 5 — Allow the participant to join 5 minutes before the meeting's start time. * 10 — Allow the participant to join 10 minutes before the meeting's start time. -
join_before_hostboolean— Whether participants can join the meeting before its host. -
mute_upon_entryboolean— Whether to automatically mute all participants when they join the meeting. -
participants_videoboolean— Whether to start meetings with the participant video on. -
personal_meetingboolean— The personal meeting settings: * true — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings. * false — Indicates that the **Enable Personal Meeting ID** setting is [disabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443). When this setting is **disabled**, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. **For Zoom Phone only:** If a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled. -
pmi_passwordstring— The PMI's password. -
pstn_password_protectedstring— Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449). -
require_password_for_instant_meetingsboolean— Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants **must** enter the generated password to join the meeting. If instant meetings use a PMI, this option is **disabled**. -
require_password_for_pmi_meetingsstring, possible values:"jbh_only", "all", "none"— Require participants to enter password for PMI meetings: * jbh_only — Only when a participant joins before the host. * all — All participants must enter a password to join the meeting. * none — No password required. -
require_password_for_scheduled_meetingsboolean— Require a passcode for meetings which have already been scheduled -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do **not** use a PMI. -
upcoming_meeting_reminderboolean— Whether to receive a desktop notification for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_scheduled_meetingsboolean— Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting.
-
-
telephonyobject— Information about telephony settings.-
audio_conference_infostring— Information about the third-party audio configuration. -
show_international_numbers_linkboolean— Whether to display the international numbers link on the invitation email. -
telephony_regionsobject— Information about where most of the participants call into or call from during a meeting.-
allowed_valuesarray— The telephony region options provided by Zoom.Items:
string -
selection_valuesstring— The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join the meeting using an existing third-party audio configuration.
-
-
tspobject— Information about the Telephony Service Provider (TSP) settings.-
call_outboolean— Whether the [**Call Me**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) feature is enabled. When enabled, the user can enter their phone number to join meetings. As a meeting host, the user can use the **Invite by Phone** feature to invite participants to join by phone. -
call_out_countriesarray— A list of countries and regions to which the user can call out to.Items:
string -
display_toll_free_numbersboolean— Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client. -
global_dial_in_countriesobject— Information about the global dial-in countries settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.Items:
-
codestring— The code of the country or region. -
namestring— The name of the country or region.
-
-
-
show_international_numbers_linkboolean— Whether to show the international numbers link in the email invitation.
-
-
-
-
operator(required)string, format:email— The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997). -
operator_id(required)string— The user ID of the user who updated the settings. -
old_objectobject— Information about the user's previous settings.-
idstring— The modified user's unique ID (userId). -
settingsobject— Information about the user's previous settings. This only returns modified settings.-
audio_conferencingobject— Information about the audio conferencing settings.-
participant_phone_maskingobject— Information about the participant phone masking settings.-
enableboolean— Whether to mask phone numbers of users dialing into a meeting in the participant list. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
-
email_notificationobject— Information about the email notification settings.-
alternative_host_reminderboolean— Whether to notify when an alternative host is added to or removed from a meeting. -
cancel_meeting_reminderboolean— Whether to notify the host and participants when a meeting is canceled. -
cloud_recording_available_reminderboolean— Whether to notify the host when a cloud recording is available. -
jbh_reminderboolean— Whether to notify the host when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
-
-
featureobject— Information about the features available to the user.-
cn_meetingboolean— Host meeting in China. -
concurrent_meetingstring, possible values:"Basic", "Plus", "None"— The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: * Basic * Plus * None **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription. -
in_meetingboolean— Host meeting in India. -
large_meetingboolean— Whether the large meeting feature is enabled. -
large_meeting_capacityinteger, possible values:500, 1000— The capacity for the user's large meetings: * 500 * 1000 -
meeting_capacityinteger— The user's meeting capacity. -
webinarboolean— Whether the user has the Webinar feature. -
webinar_capacityinteger, possible values:100, 500, 1000, 3000, 5000, 10000— If the user has a Webinar capacity plan subscription, the user's Webinar capacity: * 100 * 500 * 1000 * 3000 * 5000 * 10000 -
zoom_eventsboolean— Whether the user has the Zoom Events feature. -
zoom_events_capacityinteger, possible values:500, 1000, 3000, 5000, 10000, 20000, 30000, 50000— If the user has the Zoom Events feature, the user's Zoom Events plan capacity: * 500 * 1000 * 3000 * 5000 * 10000 * 20000 * 30000 * 50000 -
zoom_phoneboolean— Whether the Zoom Phone feature is enabled.
-
-
in_meetingobject— Information about the in meeting settings.-
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_host_to_enable_focus_modeboolean— Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting. -
allow_live_streamingboolean— Whether to allow livestreaming. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can chat with certain groups: * 1 — The participants cannot use chat. * 2 — Host and co-hosts only. * 3 — The participants can chat with other participants publicly. * 4 - The participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether participants can use annotation tools to add information to shared screens. -
attendee_on_holdboolean— Whether hosts can temporarily remove an attendee from a meeting. -
attention_mode_focus_modeboolean— Whether the [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. -
auto_answerboolean— Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled. -
auto_saving_chatboolean— Whether to automatically save all in-meeting chats. -
breakout_roomboolean— Whether the host can split meeting participants into separate, smaller rooms. -
breakout_room_scheduleboolean— Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400). -
closed_captionboolean— Whether closed captions are enabled. -
closed_captioningobject— Information about the closed captioning settings.-
auto_transcribingboolean— Whether to allow a live transcription service to transcribe meetings. -
enableboolean— Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning. -
save_captionboolean— Whether to allow participants to save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether to allow the use of an API token to integrate with 3rd-party closed captioning services. -
view_full_transcriptboolean— Whether to allow the viewing of full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether to allow the meeting host to add co-hosts. -
custom_data_center_regionsboolean— Whether custom [data center regions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060026) are enabled for hosting real-time meeting and webinar traffic: * true — Enabled. Provide the data center regions in the data_center_regions field. * false — Disabled. Only use the default data center regions. -
custom_live_streaming_serviceboolean— Whether to allow custom livestreaming. -
custom_service_instructionsstring— The custom livestreaming service instructions. -
data_center_regionsarray— The user's selected custom data center regions. This field only returns if the custom_data_center_regions value is true: * 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the **Disable desktop screen sharing for meetings you host** setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings. -
entry_exit_chimestring— The sound that plays when participants join or leave the meeting: * host — Chime when host joins or leaves a meeting. * all — Chime when any participant joins or leaves a meeting. * none — Do not chime. -
far_end_camera_controlboolean— Whether another user can take control of camera during a meeting. -
feedbackboolean— Whether users can send feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether file sharing via in-meeting chat is enabled. -
group_hdboolean— Whether group HD video is enabled. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings.-
custom_languagesarray, default:null— A list of user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters to interpret one language into another in real-time. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether to allow Facebook livestreaming. -
live_streaming_youtubeboolean— Whether to allow YouTube livestreaming. -
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323) located in the **Reactions** menu in the meeting toolbar. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— 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. -
non_verbal_feedbackboolean— Whether non-verbal feedback through screensharing is enabled. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether polls are available in the meeting controls. -
post_meeting_feedbackboolean— Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. -
private_chatboolean— Whether meeting participants can use private chat. -
record_play_voiceboolean— When a participant joins by telephone, whether recording and playing the participant's own voice is enabled. -
remote_controlboolean— Whether users can request remote control. -
remote_supportboolean— Whether the host can provide 1:1 remote support to a participant. -
screen_sharingboolean— Whether to allow hosts and participants to share their screen or content during meetings. -
share_dual_cameraboolean— Share dual camera. This field is **deprecated**. -
show_a_join_from_your_browser_linkboolean— Whether participants can join a meeting directly from their browser and bypass the Zoom application download process. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
virtual_backgroundboolean— Whether users can change their background. -
virtual_background_settingsobject— Information about the virtual background settings.-
allow_upload_customboolean— Whether users can upload custom backgrounds. -
allow_videosboolean— Whether the use of videos for virtual backgrounds is enabled. -
enableboolean— Whether virtual backgrounds are enabled. -
filesarray— Information about virtual background files.Items:
-
idstring— The file's unique ID. -
is_defaultboolean— Whether the file is the default virtual background file. -
namestring— The file's name. -
sizeinteger— The file' size. -
typestring— The file's type.
-
-
-
waiting_roomboolean— Whether the [Waiting Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) feature is enabled. When enabled, attendees can only join after the host approves their entry. -
webinar_chatobject— Whether webinar participants can send chat messages.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— Webinar attendees can chat with: * 1 — No one. * 2 — Host and all panelists. * 3 — Everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— Webinar panelists can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether webinar participants can send chat messages.
-
-
webinar_live_streamingobject— Whether webinar livestreaming is enabled.-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject— Information about the account's webinar polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395). -
webinar_surveyboolean— Whether to allow the host to present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature. -
who_can_share_screenstring, possible values:"host", "all"— 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. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— 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. -
workplace_by_facebookboolean— Whether to allow Workplace by Facebook livestreaming.
-
-
meeting_securityobject— Whether to require that all meetings are secured with at least one security option.-
auto_securityboolean— 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. -
block_user_domainboolean— Whether to block users in specific domains from joining meetings and webinars. -
block_user_domain_listarray— The domain to block, up to 20 domains. For example, the *.example.com domain.Items:
string -
embed_password_in_join_linkboolean— 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. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0065408), such as cloud recording, live streaming, and allowing participants to join before the host. -
end_to_end_encrypted_meetingsboolean— Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the encryption_type field. -
meeting_passwordboolean— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting. -
meeting_password_requirementobject— Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether to specify that only authenticated users can join the meeting from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether to require a password for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether to require a password for webinars that have already been scheduled. -
waiting_roomboolean— Whether participants are placed in the [**Waiting Room**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) when they join a meeting. If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060501) setting is automatically disabled. -
waiting_room_settingsobject— Information about the waiting room settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0061263). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— 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").
-
-
webinar_passwordboolean— Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
recordingobject— Information about recording settings.-
ask_host_to_confirm_disclaimerboolean— Whether to ask the host to confirm the recording disclaimer is enabled. -
ask_participants_to_consent_disclaimerboolean— Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the recording_disclaimer field is set to true. -
auto_delete_cmrboolean— Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the auto_delete_cmr_days field. -
auto_delete_cmr_daysinteger, possible values:30, 60, 90, 120— 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. -
auto_recordingstring, possible values:"local", "cloud", "none"— The automatic recording setting: * local — Record locally * cloud — Record on the cloud. * none — Disabled. -
cloud_recordingboolean— Whether hosts can record and save the meeting or webinar in the cloud. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_pause_stop_recordingboolean— Whether the meeting's host can pause or stop the cloud's auto recording is enabled. -
ip_address_access_controlobject— Information about the settings to allow cloud recording access only from specific IP address ranges.-
enableboolean— Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the ip_addresses_or_ranges property. -
ip_addresses_or_rangesstring— The IP addresses or ranges that have access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record the meeting using a local file. -
optimize_recording_for_3rd_party_video_editorboolean— 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. -
record_audio_fileboolean— Whether recording an audio-only file is enabled. -
record_audio_file_each_participantboolean— Whether to record separate audio files for each participant is enabled. -
record_files_separatelyobject— The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676) settings.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether recording the [gallery view](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062314) with a shared screen is enabled. -
record_speaker_viewboolean— Whether recording the active speaker with a shared screen is enabled. -
recording_audio_transcriptboolean— Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled. -
recording_disclaimerboolean— Whether to display a disclaimer to participants before a recording begins is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled. -
recording_password_requirementobject— Information about the minimum password requirements for recordings via the Account Recording settings.-
have_letterboolean— Whether the password must contain at least one alphabetical letter. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character (for example, !, @, or #). -
lengthinteger— The password's minimum required length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters.
-
-
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether saving the chat text from the meeting to the cloud is enabled. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062490) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether adding a timestamp to the recording is enabled.
-
-
schedule_meetingobject— Information about the scheduled meeting settings.-
audio_typestring— The type of audio used to join the meeting. -
default_password_for_scheduled_meetingsboolean— Whether to use the default password for already scheduled meetings. -
force_pmi_jbh_passwordstring— Whether to require a password for personal meetings if attendees can join before host. -
host_videoboolean— Whether to start meetings with the host video on. -
jbh_timeinteger, possible values:0, 5, 10, 15— If the value of the join_before_host field is true, this field indicates the time limits within which a participant can join a meeting before the meeting's host: * 0 — Allow the participant to join the meeting at anytime. * 5 — Allow the participant to join 5 minutes before the meeting's start time. * 10 — Allow the participant to join 10 minutes before the meeting's start time. -
join_before_hostboolean— Whether participants can join the meeting before its host. -
mute_upon_entryboolean— Whether to automatically mute all participants when they join the meeting. -
participants_videoboolean— Whether to start meetings with the participant video on. -
personal_meetingboolean— The personal meeting settings: * true — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings. * false — Indicates that the **Enable Personal Meeting ID** setting is [disabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443). When this setting is **disabled**, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. **For Zoom Phone only:** If a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled. -
pmi_passwordstring— The PMI's password. -
pstn_password_protectedstring— Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449). -
require_password_for_instant_meetingsboolean— Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants **must** enter the generated password to join the meeting. If instant meetings use a PMI, this option is **disabled**. -
require_password_for_pmi_meetingsstring, possible values:"jbh_only", "all", "none"— Require participants to enter password for PMI meetings: * jbh_only — Only when a participant joins before the host. * all — All participants must enter a password to join the meeting. * none — No password required. -
require_password_for_scheduled_meetingsboolean— Require a passcode for meetings which have already been scheduled -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do **not** use a PMI. -
upcoming_meeting_reminderboolean— Whether to receive a desktop notification for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_scheduled_meetingsboolean— Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting.
-
-
telephonyobject— Information about telephony settings.-
audio_conference_infostring— Information about the third-party audio configuration. -
show_international_numbers_linkboolean— Whether to display the international numbers link on the invitation email. -
telephony_regionsobject— Information about where most of the participants call into or call from during a meeting.-
allowed_valuesarray— The telephony region options provided by Zoom.Items:
string -
selection_valuesstring— The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join the meeting using an existing third-party audio configuration.
-
-
tspobject— Information about the Telephony Service Provider (TSP) settings.-
call_outboolean— Whether the [**Call Me**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) feature is enabled. When enabled, the user can enter their phone number to join meetings. As a meeting host, the user can use the **Invite by Phone** feature to invite participants to join by phone. -
call_out_countriesarray— A list of countries and regions to which the user can call out to.Items:
string -
display_toll_free_numbersboolean— Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client. -
global_dial_in_countriesobject— Information about the global dial-in countries settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.Items:
-
codestring— The code of the country or region. -
namestring— The name of the country or region.
-
-
-
show_international_numbers_linkboolean— Whether to show the international numbers link in the email invitation.
-
-
-
-
time_stampinteger— A timestamp that indicates when the setting was updated.
-
-
operatorstring, format:email— The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997). -
operator_idstring— The user ID of the user who updated the settings. -
time_stampinteger— A timestamp that indicates when the setting was updated.
Example:
{
"event": "",
"event_ts": 1,
"operator": "",
"operator_id": "",
"time_stamp": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"schedule_meeting": {
"host_video": true,
"participants_video": true,
"audio_type": "",
"join_before_host": true,
"force_pmi_jbh_password": "",
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"default_password_for_scheduled_meetings": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"post_meeting_feedback": true,
"whiteboard": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"auto_saving_chat": true,
"entry_exit_chime": "",
"record_play_voice": true,
"file_transfer": true,
"feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"annotation": true,
"remote_control": true,
"non_verbal_feedback": true,
"breakout_room": true,
"breakout_room_schedule": true,
"remote_support": true,
"screen_sharing": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"closed_caption": true,
"group_hd": true,
"far_end_camera_control": true,
"waiting_room": true,
"virtual_background": true,
"virtual_background_settings": {
"enable": true,
"allow_videos": true,
"allow_upload_custom": true,
"files": [
{
"id": "",
"name": "",
"type": "",
"is_default": true,
"size": 1
}
]
},
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"languages": "English",
"custom_languages": null
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
"Language1"
]
},
"meeting_question_answer": true,
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"auto_answer": true,
"allow_show_zoom_windows": true
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "local",
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"show_international_numbers_link": true,
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"feature": {
"meeting_capacity": 1,
"large_meeting": true,
"large_meeting_capacity": 500,
"webinar": true,
"webinar_capacity": 100,
"zoom_events": true,
"zoom_events_capacity": 500,
"zoom_phone": true,
"concurrent_meeting": "Basic"
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"only_authenticated_can_join_from_webclient": true,
"block_user_domain_list": [
""
]
},
"tsp": {
"call_out": true,
"call_out_countries": [
""
],
"show_international_numbers_link": true,
"display_toll_free_numbers": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
}
}
},
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"schedule_meeting": {
"host_video": true,
"participants_video": true,
"audio_type": "",
"join_before_host": true,
"force_pmi_jbh_password": "",
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"default_password_for_scheduled_meetings": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"post_meeting_feedback": true,
"whiteboard": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"auto_saving_chat": true,
"entry_exit_chime": "",
"record_play_voice": true,
"file_transfer": true,
"feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"annotation": true,
"remote_control": true,
"non_verbal_feedback": true,
"breakout_room": true,
"breakout_room_schedule": true,
"remote_support": true,
"screen_sharing": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"closed_caption": true,
"group_hd": true,
"far_end_camera_control": true,
"waiting_room": true,
"virtual_background": true,
"virtual_background_settings": {
"enable": true,
"allow_videos": true,
"allow_upload_custom": true,
"files": [
{
"id": "",
"name": "",
"type": "",
"is_default": true,
"size": 1
}
]
},
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"languages": "English",
"custom_languages": null
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
"Language1"
]
},
"meeting_question_answer": true,
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"auto_answer": true,
"allow_show_zoom_windows": true
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "local",
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"show_international_numbers_link": true,
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"feature": {
"meeting_capacity": 1,
"large_meeting": true,
"large_meeting_capacity": 500,
"webinar": true,
"webinar_capacity": 100,
"zoom_events": true,
"zoom_events_capacity": 500,
"zoom_phone": true,
"concurrent_meeting": "Basic"
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"only_authenticated_can_join_from_webclient": true,
"block_user_domain_list": [
""
]
},
"tsp": {
"call_out": true,
"call_out_countries": [
""
],
"show_international_numbers_link": true,
"display_toll_free_numbers": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
}
}
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The event's name. -
event_ts(required)integer, format:int64— A timestamp, in milliseconds since epoch, at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account that updated the settings. -
object(required)object— Information about the user.-
id(required)string— The modified user's unique ID (userId). -
settings(required)object-
audio_conferencingobject— Information about the audio conferencing settings.-
participant_phone_maskingobject— Information about the participant phone masking settings.-
enableboolean— Whether to mask phone numbers of users dialing into a meeting in the participant list. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
-
email_notificationobject— Information about the email notification settings.-
alternative_host_reminderboolean— Whether to notify when an alternative host is added to or removed from a meeting. -
cancel_meeting_reminderboolean— Whether to notify the host and participants when a meeting is canceled. -
cloud_recording_available_reminderboolean— Whether to notify the host when a cloud recording is available. -
jbh_reminderboolean— Whether to notify the host when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
-
-
featureobject— Information about the features available to the user.-
cn_meetingboolean— Host meeting in China. -
concurrent_meetingstring, possible values:"Basic", "Plus", "None"— The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: * Basic * Plus * None **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription. -
in_meetingboolean— Host meeting in India. -
large_meetingboolean— Whether the large meeting feature is enabled. -
large_meeting_capacityinteger, possible values:500, 1000— The capacity for the user's large meetings: * 500 * 1000 -
meeting_capacityinteger— The user's meeting capacity. -
webinarboolean— Whether the user has the Webinar feature. -
webinar_capacityinteger, possible values:100, 500, 1000, 3000, 5000, 10000— If the user has a Webinar capacity plan subscription, the user's Webinar capacity: * 100 * 500 * 1000 * 3000 * 5000 * 10000 -
zoom_eventsboolean— Whether the user has the Zoom Events feature. -
zoom_events_capacityinteger, possible values:500, 1000, 3000, 5000, 10000, 20000, 30000, 50000— If the user has the Zoom Events feature, the user's Zoom Events plan capacity: * 500 * 1000 * 3000 * 5000 * 10000 * 20000 * 30000 * 50000 -
zoom_phoneboolean— Whether the Zoom Phone feature is enabled.
-
-
in_meetingobject— Information about the in meeting settings.-
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_host_to_enable_focus_modeboolean— Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting. -
allow_live_streamingboolean— Whether to allow livestreaming. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can chat with certain groups: * 1 — The participants cannot use chat. * 2 — Host and co-hosts only. * 3 — The participants can chat with other participants publicly. * 4 - The participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether participants can use annotation tools to add information to shared screens. -
attendee_on_holdboolean— Whether hosts can temporarily remove an attendee from a meeting. -
attention_mode_focus_modeboolean— Whether the [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. -
auto_answerboolean— Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled. -
auto_saving_chatboolean— Whether to automatically save all in-meeting chats. -
breakout_roomboolean— Whether the host can split meeting participants into separate, smaller rooms. -
breakout_room_scheduleboolean— Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400). -
closed_captionboolean— Whether closed captions are enabled. -
closed_captioningobject— Information about the closed captioning settings.-
auto_transcribingboolean— Whether to allow a live transcription service to transcribe meetings. -
enableboolean— Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning. -
save_captionboolean— Whether to allow participants to save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether to allow the use of an API token to integrate with 3rd-party closed captioning services. -
view_full_transcriptboolean— Whether to allow the viewing of full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether to allow the meeting host to add co-hosts. -
custom_data_center_regionsboolean— Whether custom [data center regions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060026) are enabled for hosting real-time meeting and webinar traffic: * true — Enabled. Provide the data center regions in the data_center_regions field. * false — Disabled. Only use the default data center regions. -
custom_live_streaming_serviceboolean— Whether to allow custom livestreaming. -
custom_service_instructionsstring— The custom livestreaming service instructions. -
data_center_regionsarray— The user's selected custom data center regions. This field only returns if the custom_data_center_regions value is true: * 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the **Disable desktop screen sharing for meetings you host** setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings. -
entry_exit_chimestring— The sound that plays when participants join or leave the meeting: * host — Chime when host joins or leaves a meeting. * all — Chime when any participant joins or leaves a meeting. * none — Do not chime. -
far_end_camera_controlboolean— Whether another user can take control of camera during a meeting. -
feedbackboolean— Whether users can send feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether file sharing via in-meeting chat is enabled. -
group_hdboolean— Whether group HD video is enabled. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings.-
custom_languagesarray, default:null— A list of user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters to interpret one language into another in real-time. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether to allow Facebook livestreaming. -
live_streaming_youtubeboolean— Whether to allow YouTube livestreaming. -
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323) located in the **Reactions** menu in the meeting toolbar. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— 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. -
non_verbal_feedbackboolean— Whether non-verbal feedback through screensharing is enabled. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether polls are available in the meeting controls. -
post_meeting_feedbackboolean— Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. -
private_chatboolean— Whether meeting participants can use private chat. -
record_play_voiceboolean— When a participant joins by telephone, whether recording and playing the participant's own voice is enabled. -
remote_controlboolean— Whether users can request remote control. -
remote_supportboolean— Whether the host can provide 1:1 remote support to a participant. -
screen_sharingboolean— Whether to allow hosts and participants to share their screen or content during meetings. -
share_dual_cameraboolean— Share dual camera. This field is **deprecated**. -
show_a_join_from_your_browser_linkboolean— Whether participants can join a meeting directly from their browser and bypass the Zoom application download process. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
virtual_backgroundboolean— Whether users can change their background. -
virtual_background_settingsobject— Information about the virtual background settings.-
allow_upload_customboolean— Whether users can upload custom backgrounds. -
allow_videosboolean— Whether the use of videos for virtual backgrounds is enabled. -
enableboolean— Whether virtual backgrounds are enabled. -
filesarray— Information about virtual background files.Items:
-
idstring— The file's unique ID. -
is_defaultboolean— Whether the file is the default virtual background file. -
namestring— The file's name. -
sizeinteger— The file' size. -
typestring— The file's type.
-
-
-
waiting_roomboolean— Whether the [Waiting Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) feature is enabled. When enabled, attendees can only join after the host approves their entry. -
webinar_chatobject— Whether webinar participants can send chat messages.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— Webinar attendees can chat with: * 1 — No one. * 2 — Host and all panelists. * 3 — Everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— Webinar panelists can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether webinar participants can send chat messages.
-
-
webinar_live_streamingobject— Whether webinar livestreaming is enabled.-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject— Information about the account's webinar polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395). -
webinar_surveyboolean— Whether to allow the host to present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature. -
who_can_share_screenstring, possible values:"host", "all"— 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. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— 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. -
workplace_by_facebookboolean— Whether to allow Workplace by Facebook livestreaming.
-
-
meeting_securityobject— Whether to require that all meetings are secured with at least one security option.-
auto_securityboolean— 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. -
block_user_domainboolean— Whether to block users in specific domains from joining meetings and webinars. -
block_user_domain_listarray— The domain to block, up to 20 domains. For example, the *.example.com domain.Items:
string -
embed_password_in_join_linkboolean— 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. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0065408), such as cloud recording, live streaming, and allowing participants to join before the host. -
end_to_end_encrypted_meetingsboolean— Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the encryption_type field. -
meeting_passwordboolean— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting. -
meeting_password_requirementobject— Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether to specify that only authenticated users can join the meeting from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether to require a password for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether to require a password for webinars that have already been scheduled. -
waiting_roomboolean— Whether participants are placed in the [**Waiting Room**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) when they join a meeting. If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060501) setting is automatically disabled. -
waiting_room_settingsobject— Information about the waiting room settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0061263). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— 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").
-
-
webinar_passwordboolean— Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
recordingobject— Information about recording settings.-
ask_host_to_confirm_disclaimerboolean— Whether to ask the host to confirm the recording disclaimer is enabled. -
ask_participants_to_consent_disclaimerboolean— Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the recording_disclaimer field is set to true. -
auto_delete_cmrboolean— Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the auto_delete_cmr_days field. -
auto_delete_cmr_daysinteger, possible values:30, 60, 90, 120— 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. -
auto_recordingstring, possible values:"local", "cloud", "none"— The automatic recording setting: * local — Record locally * cloud — Record on the cloud. * none — Disabled. -
cloud_recordingboolean— Whether hosts can record and save the meeting or webinar in the cloud. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_pause_stop_recordingboolean— Whether the meeting's host can pause or stop the cloud's auto recording is enabled. -
ip_address_access_controlobject— Information about the settings to allow cloud recording access only from specific IP address ranges.-
enableboolean— Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the ip_addresses_or_ranges property. -
ip_addresses_or_rangesstring— The IP addresses or ranges that have access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record the meeting using a local file. -
optimize_recording_for_3rd_party_video_editorboolean— 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. -
record_audio_fileboolean— Whether recording an audio-only file is enabled. -
record_audio_file_each_participantboolean— Whether to record separate audio files for each participant is enabled. -
record_files_separatelyobject— The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676) settings.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether recording the [gallery view](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062314) with a shared screen is enabled. -
record_speaker_viewboolean— Whether recording the active speaker with a shared screen is enabled. -
recording_audio_transcriptboolean— Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled. -
recording_disclaimerboolean— Whether to display a disclaimer to participants before a recording begins is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled. -
recording_password_requirementobject— Information about the minimum password requirements for recordings via the Account Recording settings.-
have_letterboolean— Whether the password must contain at least one alphabetical letter. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character (for example, !, @, or #). -
lengthinteger— The password's minimum required length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters.
-
-
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether saving the chat text from the meeting to the cloud is enabled. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062490) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether adding a timestamp to the recording is enabled.
-
-
schedule_meetingobject— Information about the scheduled meeting settings.-
audio_typestring— The type of audio used to join the meeting. -
default_password_for_scheduled_meetingsboolean— Whether to use the default password for already scheduled meetings. -
force_pmi_jbh_passwordstring— Whether to require a password for personal meetings if attendees can join before host. -
host_videoboolean— Whether to start meetings with the host video on. -
jbh_timeinteger, possible values:0, 5, 10, 15— If the value of the join_before_host field is true, this field indicates the time limits within which a participant can join a meeting before the meeting's host: * 0 — Allow the participant to join the meeting at anytime. * 5 — Allow the participant to join 5 minutes before the meeting's start time. * 10 — Allow the participant to join 10 minutes before the meeting's start time. -
join_before_hostboolean— Whether participants can join the meeting before its host. -
mute_upon_entryboolean— Whether to automatically mute all participants when they join the meeting. -
participants_videoboolean— Whether to start meetings with the participant video on. -
personal_meetingboolean— The personal meeting settings: * true — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings. * false — Indicates that the **Enable Personal Meeting ID** setting is [disabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443). When this setting is **disabled**, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. **For Zoom Phone only:** If a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled. -
pmi_passwordstring— The PMI's password. -
pstn_password_protectedstring— Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449). -
require_password_for_instant_meetingsboolean— Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants **must** enter the generated password to join the meeting. If instant meetings use a PMI, this option is **disabled**. -
require_password_for_pmi_meetingsstring, possible values:"jbh_only", "all", "none"— Require participants to enter password for PMI meetings: * jbh_only — Only when a participant joins before the host. * all — All participants must enter a password to join the meeting. * none — No password required. -
require_password_for_scheduled_meetingsboolean— Require a passcode for meetings which have already been scheduled -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do **not** use a PMI. -
upcoming_meeting_reminderboolean— Whether to receive a desktop notification for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_scheduled_meetingsboolean— Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting.
-
-
telephonyobject— Information about telephony settings.-
audio_conference_infostring— Information about the third-party audio configuration. -
show_international_numbers_linkboolean— Whether to display the international numbers link on the invitation email. -
telephony_regionsobject— Information about where most of the participants call into or call from during a meeting.-
allowed_valuesarray— The telephony region options provided by Zoom.Items:
string -
selection_valuesstring— The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join the meeting using an existing third-party audio configuration.
-
-
tspobject— Information about the Telephony Service Provider (TSP) settings.-
call_outboolean— Whether the [**Call Me**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) feature is enabled. When enabled, the user can enter their phone number to join meetings. As a meeting host, the user can use the **Invite by Phone** feature to invite participants to join by phone. -
call_out_countriesarray— A list of countries and regions to which the user can call out to.Items:
string -
display_toll_free_numbersboolean— Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client. -
global_dial_in_countriesobject— Information about the global dial-in countries settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.Items:
-
codestring— The code of the country or region. -
namestring— The name of the country or region.
-
-
-
show_international_numbers_linkboolean— Whether to show the international numbers link in the email invitation.
-
-
-
-
operator(required)string, format:email— The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997). -
operator_id(required)string— The user ID of the user who updated the settings. -
old_objectobject— Information about the user's previous settings.-
idstring— The modified user's unique ID (userId). -
settingsobject— Information about the user's previous settings. This only returns modified settings.-
audio_conferencingobject— Information about the audio conferencing settings.-
participant_phone_maskingobject— Information about the participant phone masking settings.-
enableboolean— Whether to mask phone numbers of users dialing into a meeting in the participant list. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
-
email_notificationobject— Information about the email notification settings.-
alternative_host_reminderboolean— Whether to notify when an alternative host is added to or removed from a meeting. -
cancel_meeting_reminderboolean— Whether to notify the host and participants when a meeting is canceled. -
cloud_recording_available_reminderboolean— Whether to notify the host when a cloud recording is available. -
jbh_reminderboolean— Whether to notify the host when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
-
-
featureobject— Information about the features available to the user.-
cn_meetingboolean— Host meeting in China. -
concurrent_meetingstring, possible values:"Basic", "Plus", "None"— The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: * Basic * Plus * None **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription. -
in_meetingboolean— Host meeting in India. -
large_meetingboolean— Whether the large meeting feature is enabled. -
large_meeting_capacityinteger, possible values:500, 1000— The capacity for the user's large meetings: * 500 * 1000 -
meeting_capacityinteger— The user's meeting capacity. -
webinarboolean— Whether the user has the Webinar feature. -
webinar_capacityinteger, possible values:100, 500, 1000, 3000, 5000, 10000— If the user has a Webinar capacity plan subscription, the user's Webinar capacity: * 100 * 500 * 1000 * 3000 * 5000 * 10000 -
zoom_eventsboolean— Whether the user has the Zoom Events feature. -
zoom_events_capacityinteger, possible values:500, 1000, 3000, 5000, 10000, 20000, 30000, 50000— If the user has the Zoom Events feature, the user's Zoom Events plan capacity: * 500 * 1000 * 3000 * 5000 * 10000 * 20000 * 30000 * 50000 -
zoom_phoneboolean— Whether the Zoom Phone feature is enabled.
-
-
in_meetingobject— Information about the in meeting settings.-
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_host_to_enable_focus_modeboolean— Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting. -
allow_live_streamingboolean— Whether to allow livestreaming. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can chat with certain groups: * 1 — The participants cannot use chat. * 2 — Host and co-hosts only. * 3 — The participants can chat with other participants publicly. * 4 - The participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether participants can use annotation tools to add information to shared screens. -
attendee_on_holdboolean— Whether hosts can temporarily remove an attendee from a meeting. -
attention_mode_focus_modeboolean— Whether the [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. -
auto_answerboolean— Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled. -
auto_saving_chatboolean— Whether to automatically save all in-meeting chats. -
breakout_roomboolean— Whether the host can split meeting participants into separate, smaller rooms. -
breakout_room_scheduleboolean— Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400). -
closed_captionboolean— Whether closed captions are enabled. -
closed_captioningobject— Information about the closed captioning settings.-
auto_transcribingboolean— Whether to allow a live transcription service to transcribe meetings. -
enableboolean— Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning. -
save_captionboolean— Whether to allow participants to save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether to allow the use of an API token to integrate with 3rd-party closed captioning services. -
view_full_transcriptboolean— Whether to allow the viewing of full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether to allow the meeting host to add co-hosts. -
custom_data_center_regionsboolean— Whether custom [data center regions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060026) are enabled for hosting real-time meeting and webinar traffic: * true — Enabled. Provide the data center regions in the data_center_regions field. * false — Disabled. Only use the default data center regions. -
custom_live_streaming_serviceboolean— Whether to allow custom livestreaming. -
custom_service_instructionsstring— The custom livestreaming service instructions. -
data_center_regionsarray— The user's selected custom data center regions. This field only returns if the custom_data_center_regions value is true: * 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the **Disable desktop screen sharing for meetings you host** setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings. -
entry_exit_chimestring— The sound that plays when participants join or leave the meeting: * host — Chime when host joins or leaves a meeting. * all — Chime when any participant joins or leaves a meeting. * none — Do not chime. -
far_end_camera_controlboolean— Whether another user can take control of camera during a meeting. -
feedbackboolean— Whether users can send feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether file sharing via in-meeting chat is enabled. -
group_hdboolean— Whether group HD video is enabled. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings.-
custom_languagesarray, default:null— A list of user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters to interpret one language into another in real-time. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether to allow Facebook livestreaming. -
live_streaming_youtubeboolean— Whether to allow YouTube livestreaming. -
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323) located in the **Reactions** menu in the meeting toolbar. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— 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. -
non_verbal_feedbackboolean— Whether non-verbal feedback through screensharing is enabled. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether polls are available in the meeting controls. -
post_meeting_feedbackboolean— Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. -
private_chatboolean— Whether meeting participants can use private chat. -
record_play_voiceboolean— When a participant joins by telephone, whether recording and playing the participant's own voice is enabled. -
remote_controlboolean— Whether users can request remote control. -
remote_supportboolean— Whether the host can provide 1:1 remote support to a participant. -
screen_sharingboolean— Whether to allow hosts and participants to share their screen or content during meetings. -
share_dual_cameraboolean— Share dual camera. This field is **deprecated**. -
show_a_join_from_your_browser_linkboolean— Whether participants can join a meeting directly from their browser and bypass the Zoom application download process. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
virtual_backgroundboolean— Whether users can change their background. -
virtual_background_settingsobject— Information about the virtual background settings.-
allow_upload_customboolean— Whether users can upload custom backgrounds. -
allow_videosboolean— Whether the use of videos for virtual backgrounds is enabled. -
enableboolean— Whether virtual backgrounds are enabled. -
filesarray— Information about virtual background files.Items:
-
idstring— The file's unique ID. -
is_defaultboolean— Whether the file is the default virtual background file. -
namestring— The file's name. -
sizeinteger— The file' size. -
typestring— The file's type.
-
-
-
waiting_roomboolean— Whether the [Waiting Room](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) feature is enabled. When enabled, attendees can only join after the host approves their entry. -
webinar_chatobject— Whether webinar participants can send chat messages.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— Webinar attendees can chat with: * 1 — No one. * 2 — Host and all panelists. * 3 — Everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— Webinar panelists can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether webinar participants can send chat messages.
-
-
webinar_live_streamingobject— Whether webinar livestreaming is enabled.-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject— Information about the account's webinar polling settings.-
advanced_pollsboolean— Whether the host can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395). -
webinar_surveyboolean— Whether to allow the host to present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature. -
who_can_share_screenstring, possible values:"host", "all"— 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. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— 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. -
workplace_by_facebookboolean— Whether to allow Workplace by Facebook livestreaming.
-
-
meeting_securityobject— Whether to require that all meetings are secured with at least one security option.-
auto_securityboolean— 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. -
block_user_domainboolean— Whether to block users in specific domains from joining meetings and webinars. -
block_user_domain_listarray— The domain to block, up to 20 domains. For example, the *.example.com domain.Items:
string -
embed_password_in_join_linkboolean— 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. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0065408), such as cloud recording, live streaming, and allowing participants to join before the host. -
end_to_end_encrypted_meetingsboolean— Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the encryption_type field. -
meeting_passwordboolean— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting. -
meeting_password_requirementobject— Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether to specify that only authenticated users can join the meeting from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether to require a password for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether to require a password for webinars that have already been scheduled. -
waiting_roomboolean— Whether participants are placed in the [**Waiting Room**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063329) when they join a meeting. If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060501) setting is automatically disabled. -
waiting_room_settingsobject— Information about the waiting room settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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.com/hc/en/article?id=zm_kb&sysparm_article=KB0061263). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— 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").
-
-
webinar_passwordboolean— Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
recordingobject— Information about recording settings.-
ask_host_to_confirm_disclaimerboolean— Whether to ask the host to confirm the recording disclaimer is enabled. -
ask_participants_to_consent_disclaimerboolean— Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the recording_disclaimer field is set to true. -
auto_delete_cmrboolean— Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the auto_delete_cmr_days field. -
auto_delete_cmr_daysinteger, possible values:30, 60, 90, 120— 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. -
auto_recordingstring, possible values:"local", "cloud", "none"— The automatic recording setting: * local — Record locally * cloud — Record on the cloud. * none — Disabled. -
cloud_recordingboolean— Whether hosts can record and save the meeting or webinar in the cloud. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_pause_stop_recordingboolean— Whether the meeting's host can pause or stop the cloud's auto recording is enabled. -
ip_address_access_controlobject— Information about the settings to allow cloud recording access only from specific IP address ranges.-
enableboolean— Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the ip_addresses_or_ranges property. -
ip_addresses_or_rangesstring— The IP addresses or ranges that have access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record the meeting using a local file. -
optimize_recording_for_3rd_party_video_editorboolean— 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. -
record_audio_fileboolean— Whether recording an audio-only file is enabled. -
record_audio_file_each_participantboolean— Whether to record separate audio files for each participant is enabled. -
record_files_separatelyobject— The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676) settings.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether recording the [gallery view](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062314) with a shared screen is enabled. -
record_speaker_viewboolean— Whether recording the active speaker with a shared screen is enabled. -
recording_audio_transcriptboolean— Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled. -
recording_disclaimerboolean— Whether to display a disclaimer to participants before a recording begins is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled. -
recording_password_requirementobject— Information about the minimum password requirements for recordings via the Account Recording settings.-
have_letterboolean— Whether the password must contain at least one alphabetical letter. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character (for example, !, @, or #). -
lengthinteger— The password's minimum required length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters.
-
-
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether saving the chat text from the meeting to the cloud is enabled. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062490) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether adding a timestamp to the recording is enabled.
-
-
schedule_meetingobject— Information about the scheduled meeting settings.-
audio_typestring— The type of audio used to join the meeting. -
default_password_for_scheduled_meetingsboolean— Whether to use the default password for already scheduled meetings. -
force_pmi_jbh_passwordstring— Whether to require a password for personal meetings if attendees can join before host. -
host_videoboolean— Whether to start meetings with the host video on. -
jbh_timeinteger, possible values:0, 5, 10, 15— If the value of the join_before_host field is true, this field indicates the time limits within which a participant can join a meeting before the meeting's host: * 0 — Allow the participant to join the meeting at anytime. * 5 — Allow the participant to join 5 minutes before the meeting's start time. * 10 — Allow the participant to join 10 minutes before the meeting's start time. -
join_before_hostboolean— Whether participants can join the meeting before its host. -
mute_upon_entryboolean— Whether to automatically mute all participants when they join the meeting. -
participants_videoboolean— Whether to start meetings with the participant video on. -
personal_meetingboolean— The personal meeting settings: * true — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings. * false — Indicates that the **Enable Personal Meeting ID** setting is [disabled](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443). When this setting is **disabled**, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. **For Zoom Phone only:** If a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled. -
pmi_passwordstring— The PMI's password. -
pstn_password_protectedstring— Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449). -
require_password_for_instant_meetingsboolean— Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants **must** enter the generated password to join the meeting. If instant meetings use a PMI, this option is **disabled**. -
require_password_for_pmi_meetingsstring, possible values:"jbh_only", "all", "none"— Require participants to enter password for PMI meetings: * jbh_only — Only when a participant joins before the host. * all — All participants must enter a password to join the meeting. * none — No password required. -
require_password_for_scheduled_meetingsboolean— Require a passcode for meetings which have already been scheduled -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do **not** use a PMI. -
upcoming_meeting_reminderboolean— Whether to receive a desktop notification for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_scheduled_meetingsboolean— Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting.
-
-
telephonyobject— Information about telephony settings.-
audio_conference_infostring— Information about the third-party audio configuration. -
show_international_numbers_linkboolean— Whether to display the international numbers link on the invitation email. -
telephony_regionsobject— Information about where most of the participants call into or call from during a meeting.-
allowed_valuesarray— The telephony region options provided by Zoom.Items:
string -
selection_valuesstring— The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join the meeting using an existing third-party audio configuration.
-
-
tspobject— Information about the Telephony Service Provider (TSP) settings.-
call_outboolean— Whether the [**Call Me**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061683) feature is enabled. When enabled, the user can enter their phone number to join meetings. As a meeting host, the user can use the **Invite by Phone** feature to invite participants to join by phone. -
call_out_countriesarray— A list of countries and regions to which the user can call out to.Items:
string -
display_toll_free_numbersboolean— Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client. -
global_dial_in_countriesobject— Information about the global dial-in countries settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.Items:
-
codestring— The code of the country or region. -
namestring— The name of the country or region.
-
-
-
show_international_numbers_linkboolean— Whether to show the international numbers link in the email invitation.
-
-
-
-
time_stampinteger— A timestamp that indicates when the setting was updated.
-
-
operatorstring, format:email— The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997). -
operator_idstring— The user ID of the user who updated the settings. -
time_stampinteger— A timestamp that indicates when the setting was updated.
Example:
{
"event": "",
"event_ts": 1,
"operator": "",
"operator_id": "",
"time_stamp": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"schedule_meeting": {
"host_video": true,
"participants_video": true,
"audio_type": "",
"join_before_host": true,
"force_pmi_jbh_password": "",
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"default_password_for_scheduled_meetings": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"post_meeting_feedback": true,
"whiteboard": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"auto_saving_chat": true,
"entry_exit_chime": "",
"record_play_voice": true,
"file_transfer": true,
"feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"annotation": true,
"remote_control": true,
"non_verbal_feedback": true,
"breakout_room": true,
"breakout_room_schedule": true,
"remote_support": true,
"screen_sharing": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"closed_caption": true,
"group_hd": true,
"far_end_camera_control": true,
"waiting_room": true,
"virtual_background": true,
"virtual_background_settings": {
"enable": true,
"allow_videos": true,
"allow_upload_custom": true,
"files": [
{
"id": "",
"name": "",
"type": "",
"is_default": true,
"size": 1
}
]
},
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"languages": "English",
"custom_languages": null
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
"Language1"
]
},
"meeting_question_answer": true,
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"auto_answer": true,
"allow_show_zoom_windows": true
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "local",
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"show_international_numbers_link": true,
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"feature": {
"meeting_capacity": 1,
"large_meeting": true,
"large_meeting_capacity": 500,
"webinar": true,
"webinar_capacity": 100,
"zoom_events": true,
"zoom_events_capacity": 500,
"zoom_phone": true,
"concurrent_meeting": "Basic"
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"only_authenticated_can_join_from_webclient": true,
"block_user_domain_list": [
""
]
},
"tsp": {
"call_out": true,
"call_out_countries": [
""
],
"show_international_numbers_link": true,
"display_toll_free_numbers": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
}
}
},
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"schedule_meeting": {
"host_video": true,
"participants_video": true,
"audio_type": "",
"join_before_host": true,
"force_pmi_jbh_password": "",
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"default_password_for_scheduled_meetings": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"post_meeting_feedback": true,
"whiteboard": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"auto_saving_chat": true,
"entry_exit_chime": "",
"record_play_voice": true,
"file_transfer": true,
"feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"annotation": true,
"remote_control": true,
"non_verbal_feedback": true,
"breakout_room": true,
"breakout_room_schedule": true,
"remote_support": true,
"screen_sharing": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"closed_caption": true,
"group_hd": true,
"far_end_camera_control": true,
"waiting_room": true,
"virtual_background": true,
"virtual_background_settings": {
"enable": true,
"allow_videos": true,
"allow_upload_custom": true,
"files": [
{
"id": "",
"name": "",
"type": "",
"is_default": true,
"size": 1
}
]
},
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"languages": "English",
"custom_languages": null
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
"Language1"
]
},
"meeting_question_answer": true,
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"auto_answer": true,
"allow_show_zoom_windows": true
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "local",
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"show_international_numbers_link": true,
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"feature": {
"meeting_capacity": 1,
"large_meeting": true,
"large_meeting_capacity": 500,
"webinar": true,
"webinar_capacity": 100,
"zoom_events": true,
"zoom_events_capacity": 500,
"zoom_phone": true,
"concurrent_meeting": "Basic"
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"only_authenticated_can_join_from_webclient": true,
"block_user_domain_list": [
""
]
},
"tsp": {
"call_out": true,
"call_out_countries": [
""
],
"show_international_numbers_link": true,
"display_toll_free_numbers": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
}
}
}
}
}
POST user.invitation_accepted
- Method:
POST - Path:
user.invitation_accepted - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the invitation was sent to the user. -
object(required)object— Information about the user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the invitation was sent to the user. -
object(required)object— Information about the user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
POST group.created
- Method:
POST - Path:
group.created - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
operator(required)string, format:email— The email address of the user that created the group. -
operator_id(required)string— The user ID of the user that created the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was created, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
operator(required)string, format:email— The email address of the user that created the group. -
operator_id(required)string— The user ID of the user that created the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was created, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
}
}
}
POST group.settings_updated
- Method:
POST - Path:
group.settings_updated - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the group's settings. -
object(required)object— Information about the group's updated settings.-
id(required)string— The updated group's ID. -
settings(required)object-
audio_conferencingobject-
call_me_and_invite_by_phoneobject— The group's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VG7NCJDZ238VVXZDJ8QMH) settings.-
allow_webinar_attendees_call_meboolean— Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher. -
call_out_countriesobject— The group's call out countries/regions settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.Items:
-
codestring— The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region. -
namestring— The name of the country or region.
-
-
-
enableboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
require_press_1_for_call_mestring, possible values:"auto", "always", "never"— Require Call Me users to press 1 before being connected to the meeting. * auto - Automatically determine whether to require pressing 1 before connecting to the meeting. * always - Always require Call Me users to press 1 before connecting to the meeting. * never - Never require Call Me users to press 1 before connecting to the meeting.
-
-
participant_phone_maskingobject— The group's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings.-
enableboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callobject— The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.-
enableboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
numbersarray— The group's **Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
toll_free_and_fee_based_toll_callobject— 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.-
allow_webinar_attendees_dialboolean— Whether webinar attendees can dial in through the group's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available with version 5.2.2 or later. -
enableboolean— 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. -
numbersarray— The group's **Toll-free and Fee-based Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
-
chatobject— The account's chat settings.-
allow_users_to_add_contactsobject— Allow users to add contacts.-
enableboolean— By disabling this setting, users will not be able to add contacts. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_chat_with_othersobject— Allow users to chat with others.-
enableboolean— 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. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_search_others_optionsstring— 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. -
chat_emojisobject— Chat emojis.-
emojis_optionstring, possible values:"all", "selected" -
enableboolean— 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.
-
-
chat_etiquette_toolobject— Information about the **Chat Etiquette** Tool.-
enableboolean, default:false— 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. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
idstring— The policy ID. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated.
-
-
-
create_private_channelsboolean— Allow users to create private channels. -
create_public_channelsboolean— Allow users to create public channels. -
record_video_messagesboolean— 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. -
record_voice_messagesboolean— Allow users to record voice messages that can be sent in direct messages or group conversations. -
schedule_meetings_in_chatboolean— Schedule a meeting from chat or channel. -
screen_captureboolean— Allow users to take and send screenshots in direct messages or group conversations. -
send_data_to_third_party_archiving_serviceobject— Send data to third-party archiving service.-
enableboolean— Allow users to send data to third-party archiving service.
-
-
share_filesobject— Users can share files in chats and channels.-
enableboolean— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. -
share_optionstring, possible values:"anyone", "account", "organization"— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.
-
-
share_links_in_chatboolean— Share links to messages and channels in Team Chat.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Notify the host there is a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can only chat with certain groups: * 1 — Participants cannot use chat. * 2 — Host and co-hosts only. * 3 — Participants can chat with other participants publicly. * 4 - Participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
breakout_room_scheduleboolean— Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
closed_captioningobject— Information about the group's closed captioning settings.-
auto_transcribingboolean— Whether live transcription services are allowed to transcribe meetings. -
enableboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with third-party closed captioning services is enabled. -
view_full_transcriptboolean— Whether participants can view full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
custom_live_streaming_serviceboolean— Whether custom livestreaming is enabled. -
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
data_center_regionsarray— 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
group_hdboolean— Whether higher quality video is enabled for hosts and participants. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.-
allow_participants_to_speak_in_listening_channelboolean— Whether to allow participants to speak in listening channel. -
allow_up_to_25_custom_languages_when_scheduling_meetingsboolean— Whether to allow up to 25 custom languages when scheduling meetings. -
custom_languagesarray— A list of the user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
enable_language_interpretation_by_defaultboolean— Whether enable language interpretation by default. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether Facebook livestreaming is enabled. -
live_streaming_youtubeboolean— Whether YouTube livestreaming is enabled. -
manual_captioningobject— Information about manual captioning settings.-
allow_to_typeboolean— Whether the host can manually caption or let the host assign a participant to provide manual captioning. -
auto_generated_captionsboolean— Whether Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB) is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
manual_captionsboolean— Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled. -
save_captionsboolean— Whether participants can [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. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with a [third-party device](https://support.zoom.us/hc/en-us/articles/115002212983) for closed captioning is enabled.
-
-
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
only_host_view_device_listboolean— Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
record_play_own_voiceboolean— Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_device_listboolean— Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
unchecked_data_center_regionsarray, possible values:"EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"— 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.Items:
string -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
virtual_background_settingsobject— Information about the Virtual Background settings.-
allow_upload_customboolean— Whether users can upload custom Virtual Backgrounds. -
allow_videosboolean— Whether users can upload videos for Virtual Backgrounds. -
enableboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
filesarray— Information about the Virtual Background files.Items:
-
idstring— The file's ID. -
is_defaultboolean— Whether the file is a default Virtual Background file. -
namestring— The file's name. -
sizeinteger— The file's size, in bytes. -
typestring— The file type.
-
-
-
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatobject— Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— The webinar attendees' chat permissions: * 1 — Attendees cannot use chat. * 2 — Attendees can only chat with the host and panelists. * 3 — Attendees can chat with everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— The webinar panelists chat permissions: * 1 — Panelists can only chat with the host and panelists. * 2 — The panelists can chat with everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether in-webinar chat is enabled.
-
-
webinar_live_streamingobject-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools. -
who_can_share_screenstring, possible values:"host", "all"— The users who share their screen or content during meetings: * host — Only the host can share their screen. * all — Hosts and panelists can share their screen. Attendees **cannot** share their screen. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— The users who can start sharing screen when someone else in the meeting is sharing their screen: * host — Only the host can share the screen when someone else is sharing. * all — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing. -
workplace_by_facebookboolean— Whether Workplace by Facebook is enabled.
-
-
meeting_securityobject-
auto_securityboolean— 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
block_user_domain_listarray— A list of blocked domains.Items:
string -
chat_etiquette_toolobject— Information about the Chat Etiquette Tool.-
enableboolean— Whether the **Chat Etiquette Tool** is enabled. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
descriptionstring— The policy's description. -
idstring— The policy ID. -
is_lockedboolean— Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy. -
keywordsarray— A list of defined rule keywords.Items:
string -
namestring— The policy name. -
regular_expressionstring— The regular expression to match to the content of chat messages. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated. -
trigger_actioninteger, possible values:1, 2— The policy's trigger action: * 1 — Ask the user to confirm before they send the message. * 2 — Block the user's message.
-
-
-
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
meeting_password_requirementobject— 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).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether a password is required for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether a password is required for webinars that have already been scheduled. -
waiting_roomboolean— 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. -
waiting_room_settingsobject— Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— If the participants_to_place_in_waiting_room field is 2, a comma-separated list of the domains that can bypass the Waiting Room (for example, example.com,example2.com).
-
-
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
other_optionsobject-
allow_users_contact_support_via_chatboolean— Whether the [**Allow users to contact Zoom's Support via Chat**](https://support.zoom.us/hc/en-us/articles/360059513751-Allowing-users-to-contact-Zoom-Support-via-Chat) setting is enabled. -
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps. -
webinar_registration_optionsobject— Webinar registration options.-
allow_host_to_enable_social_share_buttonsboolean— Allow host to enable "Show social share buttons on registration page"
-
-
-
profileobject-
recording_storage_locationobject— Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings.-
allowed_valuesarray— A list of the countries where the group's recorded content is stored.Items:
string -
valuestring— The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).
-
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveobject— The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings.-
enableboolean— Whether the **Meeting and Webinar Archiving solution** feature is enabled. This feature must be enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003). -
settingsobject-
audio_fileboolean— Whether audio is included in the archive. -
cc_transcript_fileboolean— Whether closed captions are included in the archive. -
chat_fileboolean— Whether chat files are included in the archive. -
chat_with_sender_emailboolean— Whether user emails are included in the chat file. -
video_fileboolean— Whether video is included in the archive.
-
-
typeinteger, possible values:1, 2, 3— The type archiving: * 1 — Only archive meetings. * 2 — Only archive webinars. * 3 — Archive both meetings and webinars.
-
-
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
cloud_recording_download_hostboolean— Whether the host with a link to the cloud recording can download the file. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlobject— Information about the cloud recording access from specific IP address ranges.-
enableboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
ip_addresses_or_rangesstring— The IP addresses or ranges with access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
optimize_recording_for_3rd_party_video_editorboolean— Whether recordings are optimized for a third-party video editor. This can increase the file size and the time it takes to generate recording files. -
prevent_host_access_recordingboolean— Whether meeting hosts do not have access to their meeting cloud recordings. Only the admins who have recording management privilege can access them. -
record_audio_fileboolean— Whether a single audio file is recorded for all participants. -
record_audio_file_each_participantboolean— Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files. -
record_files_separatelyobject— 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.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen. -
record_speaker_viewboolean— Whether to record the active speaker when screen sharing is active. -
recording_audio_transcriptboolean— Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled. -
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether chat messages are saved from meetings or webinars. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether a timestamp is included in the recording. -
smart_recordingobject— 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.-
create_next_stepsboolean— By selecting this option, there will be a summary of actions to take after the recorded meeting. -
create_recording_highlightsboolean— 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. -
create_smart_chaptersboolean— By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
-
-
-
schedule_meetingobject-
always_display_zoom_meeting_as_topicobject— 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.-
display_topic_for_scheduled_meetingsboolean— Whether "Zoom Meeting" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always display "Zoom Meeting" as the meeting topic** setting is enabled.
-
-
always_display_zoom_webinar_as_topicobject— 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.-
display_topic_for_scheduled_webinarsboolean— Whether "Zoom Webinar" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always show "Zoom Webinar" as the webinar topic** setting is enabled.
-
-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
personal_meetingboolean— Whether the [**Personal Meeting ID (PMI)**](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI) feature is enabled. If disabled, meetings that were previously-scheduled via PMI will need to be manually updated. For Zoom Phone, if a user has been assigned a desk phone, the **Elevate to Zoom Meeting** setting is disabled. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsstring, possible values:"none", "all", "jbh_only"— Whether participants are required to enter a password for PMI meetings: * none — Do not require a password for PMI meetings. * all — Require participants to enter password for all PMI-enabled meetings. * jbh_only — Only require a password for meetings where the **Join Before Host** setting is enabled. -
require_password_for_scheduled_meetingsboolean— Whether a password is required for meetings which have already been scheduled. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a host schedules a new meeting. Participants are required to enter the password before they can join the meeting. -
upcoming_meeting_reminderboolean— Whether desktop notification are sent for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_schedule_meetingsboolean— Whether a PMI is enabled for all scheduled meetings.
-
-
telephonyobject-
audio_conference_infostring— Information about the third-party audio configuration. -
telephony_regionsobject— The telephony regions from which participants call in to or call from.-
selection_valuesstring— The account's selected telephony regions that indicate where most participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
old_object(required)object— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
settings(required)object— Information about the group's updated settings. This only returns modified settings.-
audio_conferencingobject-
call_me_and_invite_by_phoneobject— The group's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VG7NCJDZ238VVXZDJ8QMH) settings.-
allow_webinar_attendees_call_meboolean— Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher. -
call_out_countriesobject— The group's call out countries/regions settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.Items:
-
codestring— The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region. -
namestring— The name of the country or region.
-
-
-
enableboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
require_press_1_for_call_mestring, possible values:"auto", "always", "never"— Require Call Me users to press 1 before being connected to the meeting. * auto - Automatically determine whether to require pressing 1 before connecting to the meeting. * always - Always require Call Me users to press 1 before connecting to the meeting. * never - Never require Call Me users to press 1 before connecting to the meeting.
-
-
participant_phone_maskingobject— The group's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings.-
enableboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callobject— The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.-
enableboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
numbersarray— The group's **Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
toll_free_and_fee_based_toll_callobject— 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.-
allow_webinar_attendees_dialboolean— Whether webinar attendees can dial in through the group's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available with version 5.2.2 or later. -
enableboolean— 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. -
numbersarray— The group's **Toll-free and Fee-based Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
-
chatobject— The account's chat settings.-
allow_users_to_add_contactsobject— Allow users to add contacts.-
enableboolean— By disabling this setting, users will not be able to add contacts. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_chat_with_othersobject— Allow users to chat with others.-
enableboolean— 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. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_search_others_optionsstring— 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. -
chat_emojisobject— Chat emojis.-
emojis_optionstring, possible values:"all", "selected" -
enableboolean— 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.
-
-
chat_etiquette_toolobject— Information about the **Chat Etiquette** Tool.-
enableboolean, default:false— 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. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
idstring— The policy ID. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated.
-
-
-
create_private_channelsboolean— Allow users to create private channels. -
create_public_channelsboolean— Allow users to create public channels. -
record_video_messagesboolean— 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. -
record_voice_messagesboolean— Allow users to record voice messages that can be sent in direct messages or group conversations. -
schedule_meetings_in_chatboolean— Schedule a meeting from chat or channel. -
screen_captureboolean— Allow users to take and send screenshots in direct messages or group conversations. -
send_data_to_third_party_archiving_serviceobject— Send data to third-party archiving service.-
enableboolean— Allow users to send data to third-party archiving service.
-
-
share_filesobject— Users can share files in chats and channels.-
enableboolean— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. -
share_optionstring, possible values:"anyone", "account", "organization"— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.
-
-
share_links_in_chatboolean— Share links to messages and channels in Team Chat.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Notify the host there is a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can only chat with certain groups: * 1 — Participants cannot use chat. * 2 — Host and co-hosts only. * 3 — Participants can chat with other participants publicly. * 4 - Participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
breakout_room_scheduleboolean— Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
closed_captioningobject— Information about the group's closed captioning settings.-
auto_transcribingboolean— Whether live transcription services are allowed to transcribe meetings. -
enableboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with third-party closed captioning services is enabled. -
view_full_transcriptboolean— Whether participants can view full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
custom_live_streaming_serviceboolean— Whether custom livestreaming is enabled. -
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
data_center_regionsarray— 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
group_hdboolean— Whether higher quality video is enabled for hosts and participants. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.-
allow_participants_to_speak_in_listening_channelboolean— Whether to allow participants to speak in listening channel. -
allow_up_to_25_custom_languages_when_scheduling_meetingsboolean— Whether to allow up to 25 custom languages when scheduling meetings. -
custom_languagesarray— A list of the user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
enable_language_interpretation_by_defaultboolean— Whether enable language interpretation by default. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether Facebook livestreaming is enabled. -
live_streaming_youtubeboolean— Whether YouTube livestreaming is enabled. -
manual_captioningobject— Information about manual captioning settings.-
allow_to_typeboolean— Whether the host can manually caption or let the host assign a participant to provide manual captioning. -
auto_generated_captionsboolean— Whether Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB) is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
manual_captionsboolean— Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled. -
save_captionsboolean— Whether participants can [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. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with a [third-party device](https://support.zoom.us/hc/en-us/articles/115002212983) for closed captioning is enabled.
-
-
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
only_host_view_device_listboolean— Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
record_play_own_voiceboolean— Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_device_listboolean— Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
unchecked_data_center_regionsarray, possible values:"EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"— 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.Items:
string -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
virtual_background_settingsobject— Information about the Virtual Background settings.-
allow_upload_customboolean— Whether users can upload custom Virtual Backgrounds. -
allow_videosboolean— Whether users can upload videos for Virtual Backgrounds. -
enableboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
filesarray— Information about the Virtual Background files.Items:
-
idstring— The file's ID. -
is_defaultboolean— Whether the file is a default Virtual Background file. -
namestring— The file's name. -
sizeinteger— The file's size, in bytes. -
typestring— The file type.
-
-
-
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatobject— Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— The webinar attendees' chat permissions: * 1 — Attendees cannot use chat. * 2 — Attendees can only chat with the host and panelists. * 3 — Attendees can chat with everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— The webinar panelists chat permissions: * 1 — Panelists can only chat with the host and panelists. * 2 — The panelists can chat with everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether in-webinar chat is enabled.
-
-
webinar_live_streamingobject-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools. -
who_can_share_screenstring, possible values:"host", "all"— The users who share their screen or content during meetings: * host — Only the host can share their screen. * all — Hosts and panelists can share their screen. Attendees **cannot** share their screen. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— The users who can start sharing screen when someone else in the meeting is sharing their screen: * host — Only the host can share the screen when someone else is sharing. * all — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing. -
workplace_by_facebookboolean— Whether Workplace by Facebook is enabled.
-
-
meeting_securityobject-
auto_securityboolean— 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
block_user_domain_listarray— A list of blocked domains.Items:
string -
chat_etiquette_toolobject— Information about the Chat Etiquette Tool.-
enableboolean— Whether the **Chat Etiquette Tool** is enabled. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
descriptionstring— The policy's description. -
idstring— The policy ID. -
is_lockedboolean— Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy. -
keywordsarray— A list of defined rule keywords.Items:
string -
namestring— The policy name. -
regular_expressionstring— The regular expression to match to the content of chat messages. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated. -
trigger_actioninteger, possible values:1, 2— The policy's trigger action: * 1 — Ask the user to confirm before they send the message. * 2 — Block the user's message.
-
-
-
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
meeting_password_requirementobject— 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).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether a password is required for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether a password is required for webinars that have already been scheduled. -
waiting_roomboolean— 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. -
waiting_room_settingsobject— Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— If the participants_to_place_in_waiting_room field is 2, a comma-separated list of the domains that can bypass the Waiting Room (for example, example.com,example2.com).
-
-
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
other_optionsobject-
allow_users_contact_support_via_chatboolean— Whether the [**Allow users to contact Zoom's Support via Chat**](https://support.zoom.us/hc/en-us/articles/360059513751-Allowing-users-to-contact-Zoom-Support-via-Chat) setting is enabled. -
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps. -
webinar_registration_optionsobject— Webinar registration options.-
allow_host_to_enable_social_share_buttonsboolean— Allow host to enable "Show social share buttons on registration page"
-
-
-
profileobject-
recording_storage_locationobject— Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings.-
allowed_valuesarray— A list of the countries where the group's recorded content is stored.Items:
string -
valuestring— The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).
-
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveobject— The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings.-
enableboolean— Whether the **Meeting and Webinar Archiving solution** feature is enabled. This feature must be enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003). -
settingsobject-
audio_fileboolean— Whether audio is included in the archive. -
cc_transcript_fileboolean— Whether closed captions are included in the archive. -
chat_fileboolean— Whether chat files are included in the archive. -
chat_with_sender_emailboolean— Whether user emails are included in the chat file. -
video_fileboolean— Whether video is included in the archive.
-
-
typeinteger, possible values:1, 2, 3— The type archiving: * 1 — Only archive meetings. * 2 — Only archive webinars. * 3 — Archive both meetings and webinars.
-
-
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
cloud_recording_download_hostboolean— Whether the host with a link to the cloud recording can download the file. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlobject— Information about the cloud recording access from specific IP address ranges.-
enableboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
ip_addresses_or_rangesstring— The IP addresses or ranges with access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
optimize_recording_for_3rd_party_video_editorboolean— Whether recordings are optimized for a third-party video editor. This can increase the file size and the time it takes to generate recording files. -
prevent_host_access_recordingboolean— Whether meeting hosts do not have access to their meeting cloud recordings. Only the admins who have recording management privilege can access them. -
record_audio_fileboolean— Whether a single audio file is recorded for all participants. -
record_audio_file_each_participantboolean— Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files. -
record_files_separatelyobject— 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.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen. -
record_speaker_viewboolean— Whether to record the active speaker when screen sharing is active. -
recording_audio_transcriptboolean— Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled. -
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether chat messages are saved from meetings or webinars. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether a timestamp is included in the recording. -
smart_recordingobject— 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.-
create_next_stepsboolean— By selecting this option, there will be a summary of actions to take after the recorded meeting. -
create_recording_highlightsboolean— 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. -
create_smart_chaptersboolean— By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
-
-
-
schedule_meetingobject-
always_display_zoom_meeting_as_topicobject— 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.-
display_topic_for_scheduled_meetingsboolean— Whether "Zoom Meeting" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always display "Zoom Meeting" as the meeting topic** setting is enabled.
-
-
always_display_zoom_webinar_as_topicobject— 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.-
display_topic_for_scheduled_webinarsboolean— Whether "Zoom Webinar" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always show "Zoom Webinar" as the webinar topic** setting is enabled.
-
-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
personal_meetingboolean— Whether the [**Personal Meeting ID (PMI)**](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI) feature is enabled. If disabled, meetings that were previously-scheduled via PMI will need to be manually updated. For Zoom Phone, if a user has been assigned a desk phone, the **Elevate to Zoom Meeting** setting is disabled. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsstring, possible values:"none", "all", "jbh_only"— Whether participants are required to enter a password for PMI meetings: * none — Do not require a password for PMI meetings. * all — Require participants to enter password for all PMI-enabled meetings. * jbh_only — Only require a password for meetings where the **Join Before Host** setting is enabled. -
require_password_for_scheduled_meetingsboolean— Whether a password is required for meetings which have already been scheduled. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a host schedules a new meeting. Participants are required to enter the password before they can join the meeting. -
upcoming_meeting_reminderboolean— Whether desktop notification are sent for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_schedule_meetingsboolean— Whether a PMI is enabled for all scheduled meetings.
-
-
telephonyobject-
audio_conference_infostring— Information about the third-party audio configuration. -
telephony_regionsobject— The telephony regions from which participants call in to or call from.-
selection_valuesstring— The account's selected telephony regions that indicate where most participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
operator(required)string, format:email— The email address of the user that updated the group's settings. -
operator_id(required)string— The user ID of the user that updated the group's settings. -
time_stampinteger, format:int64— A timestamp that indicates when the group's settings were updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"display_number": "",
"number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 7777 777",
"number": "7777 777"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"recording_available_reminder_alternative_hosts": true,
"recording_available_reminder_schedulers": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_participants_chat_with": 1,
"allow_show_zoom_windows": true,
"allow_users_save_chats": 1,
"annotation": true,
"auto_answer": true,
"auto_saving_chat": true,
"breakout_room": true,
"breakout_room_schedule": true,
"chat": true,
"meeting_question_answer": true,
"closed_caption": true,
"closed_captioning": {
"auto_transcribing": true,
"enable": true,
"save_caption": true,
"third_party_captioning_service": true,
"view_full_transcript": true
},
"co_host": true,
"custom_data_center_regions": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"data_center_regions": [
"AU"
],
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"group_hd": true,
"join_from_desktop": true,
"join_from_mobile": true,
"language_interpretation": {
"custom_languages": [
""
],
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"enable": true,
"languages": "English"
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"live_streaming_facebook": true,
"live_streaming_youtube": true,
"manual_captioning": {
"allow_to_type": true,
"auto_generated_captions": true,
"full_transcript": true,
"manual_captions": true,
"save_captions": true,
"third_party_captioning_service": true
},
"meeting_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"only_host_view_device_list": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"record_play_own_voice": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_device_list": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"unchecked_data_center_regions": "EU",
"use_html_format_email": true,
"virtual_background": true,
"virtual_background_settings": {
"allow_upload_custom": true,
"allow_videos": true,
"enable": true,
"files": [
{
"id": "",
"is_default": true,
"name": "",
"size": 1,
"type": ""
}
]
},
"waiting_room": true,
"webinar_chat": {
"allow_attendees_chat_with": 1,
"allow_auto_save_local_chat_file": true,
"allow_panelists_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"default_attendees_chat_with": 1,
"enable": true
},
"webinar_live_streaming": {
"custom_service_instructions": "",
"enable": true,
"live_streaming_reminder": true,
"live_streaming_service": [
"facebook"
]
},
"webinar_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"webinar_question_answer": true,
"webinar_survey": true,
"whiteboard": true,
"who_can_share_screen": "host",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"workplace_by_facebook": true
},
"other_options": {
"allow_users_contact_support_via_chat": true,
"blur_snapshot": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"profile": {
"recording_storage_location": {
"allowed_values": [
""
],
"value": ""
}
},
"recording": {
"account_user_access_recording": true,
"archive": {
"enable": true,
"settings": {
"audio_file": true,
"cc_transcript_file": true,
"chat_file": true,
"chat_with_sender_email": true,
"video_file": true
},
"type": 1
},
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"display_participant_name": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"local_recording": true,
"optimize_recording_for_3rd_party_video_editor": true,
"prevent_host_access_recording": true,
"record_audio_file": true,
"record_audio_file_each_participant": true,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"record_gallery_view": true,
"record_speaker_view": true,
"recording_audio_transcript": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"recording_thumbnails": true,
"save_chat_text": true,
"save_close_caption": true,
"save_panelist_chat": true,
"save_poll_results": true,
"show_timestamp": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"mute_upon_entry": true,
"participant_video": true,
"personal_meeting": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": "none",
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_schedule_meetings": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
}
},
"telephony": {
"audio_conference_info": "",
"telephony_regions": {
"selection_values": ""
},
"third_party_audio": true
},
"meeting_security": {
"auto_security": true,
"block_user_domain": true,
"block_user_domain_list": [
""
],
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "",
"id": "",
"is_locked": true,
"keywords": [
""
],
"name": "",
"regular_expression": "",
"status": "activated",
"trigger_action": 1
}
]
},
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"meeting_password_requirement": {
"consecutive_characters_length": 0,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"have_upper_and_lower_characters": true,
"length": 1,
"only_allow_numeric": true,
"weak_enhance_detection": true
},
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"require_password_for_scheduled_meeting": true,
"require_password_for_scheduled_webinar": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"users_who_can_admit_participants_from_waiting_room": 0,
"whitelisted_domains_for_waiting_room": ""
},
"webinar_password": true
},
"chat": {
"share_files": {
"enable": true,
"share_option": true
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_search_others_options": "1,3",
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"id": "aefwf23dsv;sdo-khuity8",
"status": "Activated"
}
]
},
"send_data_to_third_party_archiving_service": {
"enable": true
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"display_number": "",
"number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 7777 777",
"number": "7777 777"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"recording_available_reminder_alternative_hosts": true,
"recording_available_reminder_schedulers": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_participants_chat_with": 1,
"allow_show_zoom_windows": true,
"allow_users_save_chats": 1,
"annotation": true,
"auto_answer": true,
"auto_saving_chat": true,
"breakout_room": true,
"breakout_room_schedule": true,
"chat": true,
"meeting_question_answer": true,
"closed_caption": true,
"closed_captioning": {
"auto_transcribing": true,
"enable": true,
"save_caption": true,
"third_party_captioning_service": true,
"view_full_transcript": true
},
"co_host": true,
"custom_data_center_regions": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"data_center_regions": [
"AU"
],
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"group_hd": true,
"join_from_desktop": true,
"join_from_mobile": true,
"language_interpretation": {
"custom_languages": [
""
],
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"enable": true,
"languages": "English"
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"live_streaming_facebook": true,
"live_streaming_youtube": true,
"manual_captioning": {
"allow_to_type": true,
"auto_generated_captions": true,
"full_transcript": true,
"manual_captions": true,
"save_captions": true,
"third_party_captioning_service": true
},
"meeting_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"only_host_view_device_list": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"record_play_own_voice": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_device_list": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"unchecked_data_center_regions": "EU",
"use_html_format_email": true,
"virtual_background": true,
"virtual_background_settings": {
"allow_upload_custom": true,
"allow_videos": true,
"enable": true,
"files": [
{
"id": "",
"is_default": true,
"name": "",
"size": 1,
"type": ""
}
]
},
"waiting_room": true,
"webinar_chat": {
"allow_attendees_chat_with": 1,
"allow_auto_save_local_chat_file": true,
"allow_panelists_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"default_attendees_chat_with": 1,
"enable": true
},
"webinar_live_streaming": {
"custom_service_instructions": "",
"enable": true,
"live_streaming_reminder": true,
"live_streaming_service": [
"facebook"
]
},
"webinar_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"webinar_question_answer": true,
"webinar_survey": true,
"whiteboard": true,
"who_can_share_screen": "host",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"workplace_by_facebook": true
},
"other_options": {
"allow_users_contact_support_via_chat": true,
"blur_snapshot": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"profile": {
"recording_storage_location": {
"allowed_values": [
""
],
"value": ""
}
},
"recording": {
"account_user_access_recording": true,
"archive": {
"enable": true,
"settings": {
"audio_file": true,
"cc_transcript_file": true,
"chat_file": true,
"chat_with_sender_email": true,
"video_file": true
},
"type": 1
},
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"display_participant_name": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"local_recording": true,
"optimize_recording_for_3rd_party_video_editor": true,
"prevent_host_access_recording": true,
"record_audio_file": true,
"record_audio_file_each_participant": true,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"record_gallery_view": true,
"record_speaker_view": true,
"recording_audio_transcript": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"recording_thumbnails": true,
"save_chat_text": true,
"save_close_caption": true,
"save_panelist_chat": true,
"save_poll_results": true,
"show_timestamp": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"mute_upon_entry": true,
"participant_video": true,
"personal_meeting": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": "none",
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_schedule_meetings": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
}
},
"telephony": {
"audio_conference_info": "",
"telephony_regions": {
"selection_values": ""
},
"third_party_audio": true
},
"meeting_security": {
"auto_security": true,
"block_user_domain": true,
"block_user_domain_list": [
""
],
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "",
"id": "",
"is_locked": true,
"keywords": [
""
],
"name": "",
"regular_expression": "",
"status": "activated",
"trigger_action": 1
}
]
},
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"meeting_password_requirement": {
"consecutive_characters_length": 0,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"have_upper_and_lower_characters": true,
"length": 1,
"only_allow_numeric": true,
"weak_enhance_detection": true
},
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"require_password_for_scheduled_meeting": true,
"require_password_for_scheduled_webinar": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"users_who_can_admit_participants_from_waiting_room": 0,
"whitelisted_domains_for_waiting_room": ""
},
"webinar_password": true
},
"chat": {
"share_files": {
"enable": true,
"share_option": true
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_search_others_options": "1,3",
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"id": "aefwf23dsv;sdo-khuity8",
"status": "Activated"
}
]
},
"send_data_to_third_party_archiving_service": {
"enable": true
}
}
}
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the group's settings. -
object(required)object— Information about the group's updated settings.-
id(required)string— The updated group's ID. -
settings(required)object-
audio_conferencingobject-
call_me_and_invite_by_phoneobject— The group's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VG7NCJDZ238VVXZDJ8QMH) settings.-
allow_webinar_attendees_call_meboolean— Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher. -
call_out_countriesobject— The group's call out countries/regions settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.Items:
-
codestring— The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region. -
namestring— The name of the country or region.
-
-
-
enableboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
require_press_1_for_call_mestring, possible values:"auto", "always", "never"— Require Call Me users to press 1 before being connected to the meeting. * auto - Automatically determine whether to require pressing 1 before connecting to the meeting. * always - Always require Call Me users to press 1 before connecting to the meeting. * never - Never require Call Me users to press 1 before connecting to the meeting.
-
-
participant_phone_maskingobject— The group's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings.-
enableboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callobject— The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.-
enableboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
numbersarray— The group's **Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
toll_free_and_fee_based_toll_callobject— 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.-
allow_webinar_attendees_dialboolean— Whether webinar attendees can dial in through the group's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available with version 5.2.2 or later. -
enableboolean— 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. -
numbersarray— The group's **Toll-free and Fee-based Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
-
chatobject— The account's chat settings.-
allow_users_to_add_contactsobject— Allow users to add contacts.-
enableboolean— By disabling this setting, users will not be able to add contacts. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_chat_with_othersobject— Allow users to chat with others.-
enableboolean— 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. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_search_others_optionsstring— 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. -
chat_emojisobject— Chat emojis.-
emojis_optionstring, possible values:"all", "selected" -
enableboolean— 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.
-
-
chat_etiquette_toolobject— Information about the **Chat Etiquette** Tool.-
enableboolean, default:false— 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. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
idstring— The policy ID. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated.
-
-
-
create_private_channelsboolean— Allow users to create private channels. -
create_public_channelsboolean— Allow users to create public channels. -
record_video_messagesboolean— 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. -
record_voice_messagesboolean— Allow users to record voice messages that can be sent in direct messages or group conversations. -
schedule_meetings_in_chatboolean— Schedule a meeting from chat or channel. -
screen_captureboolean— Allow users to take and send screenshots in direct messages or group conversations. -
send_data_to_third_party_archiving_serviceobject— Send data to third-party archiving service.-
enableboolean— Allow users to send data to third-party archiving service.
-
-
share_filesobject— Users can share files in chats and channels.-
enableboolean— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. -
share_optionstring, possible values:"anyone", "account", "organization"— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.
-
-
share_links_in_chatboolean— Share links to messages and channels in Team Chat.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Notify the host there is a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can only chat with certain groups: * 1 — Participants cannot use chat. * 2 — Host and co-hosts only. * 3 — Participants can chat with other participants publicly. * 4 - Participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
breakout_room_scheduleboolean— Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
closed_captioningobject— Information about the group's closed captioning settings.-
auto_transcribingboolean— Whether live transcription services are allowed to transcribe meetings. -
enableboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with third-party closed captioning services is enabled. -
view_full_transcriptboolean— Whether participants can view full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
custom_live_streaming_serviceboolean— Whether custom livestreaming is enabled. -
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
data_center_regionsarray— 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
group_hdboolean— Whether higher quality video is enabled for hosts and participants. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.-
allow_participants_to_speak_in_listening_channelboolean— Whether to allow participants to speak in listening channel. -
allow_up_to_25_custom_languages_when_scheduling_meetingsboolean— Whether to allow up to 25 custom languages when scheduling meetings. -
custom_languagesarray— A list of the user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
enable_language_interpretation_by_defaultboolean— Whether enable language interpretation by default. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether Facebook livestreaming is enabled. -
live_streaming_youtubeboolean— Whether YouTube livestreaming is enabled. -
manual_captioningobject— Information about manual captioning settings.-
allow_to_typeboolean— Whether the host can manually caption or let the host assign a participant to provide manual captioning. -
auto_generated_captionsboolean— Whether Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB) is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
manual_captionsboolean— Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled. -
save_captionsboolean— Whether participants can [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. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with a [third-party device](https://support.zoom.us/hc/en-us/articles/115002212983) for closed captioning is enabled.
-
-
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
only_host_view_device_listboolean— Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
record_play_own_voiceboolean— Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_device_listboolean— Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
unchecked_data_center_regionsarray, possible values:"EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"— 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.Items:
string -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
virtual_background_settingsobject— Information about the Virtual Background settings.-
allow_upload_customboolean— Whether users can upload custom Virtual Backgrounds. -
allow_videosboolean— Whether users can upload videos for Virtual Backgrounds. -
enableboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
filesarray— Information about the Virtual Background files.Items:
-
idstring— The file's ID. -
is_defaultboolean— Whether the file is a default Virtual Background file. -
namestring— The file's name. -
sizeinteger— The file's size, in bytes. -
typestring— The file type.
-
-
-
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatobject— Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— The webinar attendees' chat permissions: * 1 — Attendees cannot use chat. * 2 — Attendees can only chat with the host and panelists. * 3 — Attendees can chat with everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— The webinar panelists chat permissions: * 1 — Panelists can only chat with the host and panelists. * 2 — The panelists can chat with everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether in-webinar chat is enabled.
-
-
webinar_live_streamingobject-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools. -
who_can_share_screenstring, possible values:"host", "all"— The users who share their screen or content during meetings: * host — Only the host can share their screen. * all — Hosts and panelists can share their screen. Attendees **cannot** share their screen. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— The users who can start sharing screen when someone else in the meeting is sharing their screen: * host — Only the host can share the screen when someone else is sharing. * all — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing. -
workplace_by_facebookboolean— Whether Workplace by Facebook is enabled.
-
-
meeting_securityobject-
auto_securityboolean— 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
block_user_domain_listarray— A list of blocked domains.Items:
string -
chat_etiquette_toolobject— Information about the Chat Etiquette Tool.-
enableboolean— Whether the **Chat Etiquette Tool** is enabled. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
descriptionstring— The policy's description. -
idstring— The policy ID. -
is_lockedboolean— Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy. -
keywordsarray— A list of defined rule keywords.Items:
string -
namestring— The policy name. -
regular_expressionstring— The regular expression to match to the content of chat messages. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated. -
trigger_actioninteger, possible values:1, 2— The policy's trigger action: * 1 — Ask the user to confirm before they send the message. * 2 — Block the user's message.
-
-
-
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
meeting_password_requirementobject— 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).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether a password is required for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether a password is required for webinars that have already been scheduled. -
waiting_roomboolean— 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. -
waiting_room_settingsobject— Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— If the participants_to_place_in_waiting_room field is 2, a comma-separated list of the domains that can bypass the Waiting Room (for example, example.com,example2.com).
-
-
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
other_optionsobject-
allow_users_contact_support_via_chatboolean— Whether the [**Allow users to contact Zoom's Support via Chat**](https://support.zoom.us/hc/en-us/articles/360059513751-Allowing-users-to-contact-Zoom-Support-via-Chat) setting is enabled. -
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps. -
webinar_registration_optionsobject— Webinar registration options.-
allow_host_to_enable_social_share_buttonsboolean— Allow host to enable "Show social share buttons on registration page"
-
-
-
profileobject-
recording_storage_locationobject— Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings.-
allowed_valuesarray— A list of the countries where the group's recorded content is stored.Items:
string -
valuestring— The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).
-
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveobject— The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings.-
enableboolean— Whether the **Meeting and Webinar Archiving solution** feature is enabled. This feature must be enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003). -
settingsobject-
audio_fileboolean— Whether audio is included in the archive. -
cc_transcript_fileboolean— Whether closed captions are included in the archive. -
chat_fileboolean— Whether chat files are included in the archive. -
chat_with_sender_emailboolean— Whether user emails are included in the chat file. -
video_fileboolean— Whether video is included in the archive.
-
-
typeinteger, possible values:1, 2, 3— The type archiving: * 1 — Only archive meetings. * 2 — Only archive webinars. * 3 — Archive both meetings and webinars.
-
-
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
cloud_recording_download_hostboolean— Whether the host with a link to the cloud recording can download the file. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlobject— Information about the cloud recording access from specific IP address ranges.-
enableboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
ip_addresses_or_rangesstring— The IP addresses or ranges with access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
optimize_recording_for_3rd_party_video_editorboolean— Whether recordings are optimized for a third-party video editor. This can increase the file size and the time it takes to generate recording files. -
prevent_host_access_recordingboolean— Whether meeting hosts do not have access to their meeting cloud recordings. Only the admins who have recording management privilege can access them. -
record_audio_fileboolean— Whether a single audio file is recorded for all participants. -
record_audio_file_each_participantboolean— Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files. -
record_files_separatelyobject— 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.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen. -
record_speaker_viewboolean— Whether to record the active speaker when screen sharing is active. -
recording_audio_transcriptboolean— Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled. -
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether chat messages are saved from meetings or webinars. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether a timestamp is included in the recording. -
smart_recordingobject— 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.-
create_next_stepsboolean— By selecting this option, there will be a summary of actions to take after the recorded meeting. -
create_recording_highlightsboolean— 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. -
create_smart_chaptersboolean— By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
-
-
-
schedule_meetingobject-
always_display_zoom_meeting_as_topicobject— 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.-
display_topic_for_scheduled_meetingsboolean— Whether "Zoom Meeting" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always display "Zoom Meeting" as the meeting topic** setting is enabled.
-
-
always_display_zoom_webinar_as_topicobject— 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.-
display_topic_for_scheduled_webinarsboolean— Whether "Zoom Webinar" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always show "Zoom Webinar" as the webinar topic** setting is enabled.
-
-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
personal_meetingboolean— Whether the [**Personal Meeting ID (PMI)**](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI) feature is enabled. If disabled, meetings that were previously-scheduled via PMI will need to be manually updated. For Zoom Phone, if a user has been assigned a desk phone, the **Elevate to Zoom Meeting** setting is disabled. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsstring, possible values:"none", "all", "jbh_only"— Whether participants are required to enter a password for PMI meetings: * none — Do not require a password for PMI meetings. * all — Require participants to enter password for all PMI-enabled meetings. * jbh_only — Only require a password for meetings where the **Join Before Host** setting is enabled. -
require_password_for_scheduled_meetingsboolean— Whether a password is required for meetings which have already been scheduled. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a host schedules a new meeting. Participants are required to enter the password before they can join the meeting. -
upcoming_meeting_reminderboolean— Whether desktop notification are sent for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_schedule_meetingsboolean— Whether a PMI is enabled for all scheduled meetings.
-
-
telephonyobject-
audio_conference_infostring— Information about the third-party audio configuration. -
telephony_regionsobject— The telephony regions from which participants call in to or call from.-
selection_valuesstring— The account's selected telephony regions that indicate where most participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
old_object(required)object— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
settings(required)object— Information about the group's updated settings. This only returns modified settings.-
audio_conferencingobject-
call_me_and_invite_by_phoneobject— The group's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VG7NCJDZ238VVXZDJ8QMH) settings.-
allow_webinar_attendees_call_meboolean— Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher. -
call_out_countriesobject— The group's call out countries/regions settings.-
selected_countriesarray— The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.Items:
-
codestring— The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region. -
namestring— The name of the country or region.
-
-
-
enableboolean— Whether the group has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled. -
require_press_1_for_call_mestring, possible values:"auto", "always", "never"— Require Call Me users to press 1 before being connected to the meeting. * auto - Automatically determine whether to require pressing 1 before connecting to the meeting. * always - Always require Call Me users to press 1 before connecting to the meeting. * never - Never require Call Me users to press 1 before connecting to the meeting.
-
-
participant_phone_maskingobject— The group's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings.-
enableboolean— Whether the group has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled. -
masking_typestring, possible values:"mask_default", "mask_first_5", "mask_except_last_4"— The type of phone number masking pattern to apply. * mask_default - Default masking pattern (Example: 888****666). * mask_first_5 - Mask first five digits (Example: *****66666). * mask_except_last_4 - Mask everything except last four digits (Example: *****6666).
-
-
personal_audio_conferenceboolean— Whether the group has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMNMERFWXN5S8ZJRZZCSE) setting enabled. -
toll_callobject— The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.-
enableboolean— Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled. -
numbersarray— The group's **Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
toll_free_and_fee_based_toll_callobject— 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.-
allow_webinar_attendees_dialboolean— Whether webinar attendees can dial in through the group's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available with version 5.2.2 or later. -
enableboolean— 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. -
numbersarray— The group's **Toll-free and Fee-based Toll Call** phone number information.Items:
-
codestring— The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes). -
country_codestring— The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). -
country_namestring— The country name. -
display_numberstring— The phone number's display number. -
numberstring— The phone number.
-
-
-
-
chatobject— The account's chat settings.-
allow_users_to_add_contactsobject— Allow users to add contacts.-
enableboolean— By disabling this setting, users will not be able to add contacts. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_chat_with_othersobject— Allow users to chat with others.-
enableboolean— 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. -
selected_optioninteger, possible values:1, 2, 3, 4— 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. -
user_email_addressesstring— 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.
-
-
allow_users_to_search_others_optionsstring— 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. -
chat_emojisobject— Chat emojis.-
emojis_optionstring, possible values:"all", "selected" -
enableboolean— 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.
-
-
chat_etiquette_toolobject— Information about the **Chat Etiquette** Tool.-
enableboolean, default:false— 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. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
idstring— The policy ID. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated.
-
-
-
create_private_channelsboolean— Allow users to create private channels. -
create_public_channelsboolean— Allow users to create public channels. -
record_video_messagesboolean— 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. -
record_voice_messagesboolean— Allow users to record voice messages that can be sent in direct messages or group conversations. -
schedule_meetings_in_chatboolean— Schedule a meeting from chat or channel. -
screen_captureboolean— Allow users to take and send screenshots in direct messages or group conversations. -
send_data_to_third_party_archiving_serviceobject— Send data to third-party archiving service.-
enableboolean— Allow users to send data to third-party archiving service.
-
-
share_filesobject— Users can share files in chats and channels.-
enableboolean— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots. -
share_optionstring, possible values:"anyone", "account", "organization"— Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.
-
-
share_links_in_chatboolean— Share links to messages and channels in Team Chat.
-
-
email_notificationobject-
alternative_host_reminderboolean— Whether alternative hosts receive an email when they are added or removed to a meeting. -
cancel_meeting_reminderboolean— Whether meeting participants and hosts receive a notification when the meeting is canceled. -
cloud_recording_available_reminderboolean— Whether the host is notified when a cloud recording is available. -
jbh_reminderboolean— Whether the host is notified when participants join the meeting before them. -
recording_available_reminder_alternative_hostsboolean— Whether to notify any alternative hosts when a cloud recording is available. -
recording_available_reminder_schedulersboolean— Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available. -
schedule_for_reminderboolean— Notify the host there is a meeting is scheduled, rescheduled, or canceled.
-
-
in_meetingobject-
alert_guest_joinboolean— Whether participants that belong to your account can see that a guest (someone who does not belong to your account) is participating in the meeting. -
allow_host_panelists_to_use_audible_clapboolean— Whether to allow host and panelist to use audible clap. -
allow_live_streamingboolean— Whether livestreaming is allowed. -
allow_participants_chat_withinteger, possible values:1, 2, 3, 4— Whether participants can only chat with certain groups: * 1 — Participants cannot use chat. * 2 — Host and co-hosts only. * 3 — Participants can chat with other participants publicly. * 4 - Participants can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above. -
allow_show_zoom_windowsboolean— Whether Zoom windows display screen share. -
allow_users_save_chatsinteger, possible values:1, 2, 3— Whether participants can 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. -
allow_users_to_delete_messages_in_meeting_chatboolean— If the value of this field is set to true, allow users to delete messages in the in-meeting chat. -
annotationboolean— Whether meeting participants can use annotation tools to add information to shared screens. -
auto_answerboolean— Whether users can view and add contacts to the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) feature. Calls from members of the **Auto Answer Group** will be automatically answered the user. -
auto_saving_chatboolean— Whether all in-meeting chats are automatically saved. -
breakout_roomboolean— Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms). -
breakout_room_scheduleboolean— Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher. -
chatboolean— Whether meeting participants can send chat messages that are visible to all participants. -
closed_captionboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
closed_captioningobject— Information about the group's closed captioning settings.-
auto_transcribingboolean— Whether live transcription services are allowed to transcribe meetings. -
enableboolean— Whether the host can type closed captions or assign a participant/third party device to add closed captions. -
save_captionboolean— Whether participants can save closed captions or transcripts. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with third-party closed captioning services is enabled. -
view_full_transcriptboolean— Whether participants can view full transcripts in the in-meeting side panel.
-
-
co_hostboolean— Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host. -
custom_data_center_regionsboolean— Whether to display the custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) selected for meetings hosted by this group. -
custom_live_streaming_serviceboolean— Whether custom livestreaming is enabled. -
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
data_center_regionsarray— 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:
string, possible values:"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US" -
disable_screen_sharing_for_host_meetingsboolean— Whether the [**Disable desktop screen sharing for meetings you host**](https://support.zoom.us/hc/en-us/articles/360037710871-Disabling-desktop-screen-sharing-in-meetings) setting is enabled. -
disable_screen_sharing_for_in_meeting_guestsboolean— Whether the **Disable screen sharing when guests are in the meeting** setting is enabled. -
e2e_encryptionboolean— Whether all meetings are required to use [End-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871-End-to-end-E2EE-encryption-for-meetings). -
entry_exit_chimeboolean— Whether a chime plays when participants join or leave the meeting. -
far_end_camera_controlboolean— Whether other users are allowed to take control of the camera during a meeting. -
feedbackboolean— Whether users can provide feedback to Zoom at the end of the meeting. -
file_transferboolean— Whether the in-meeting [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting is enabled. -
group_hdboolean— Whether higher quality video is enabled for hosts and participants. -
join_from_desktopboolean— Whether participants can join a meeting directly from their desktop browser. -
join_from_mobileboolean— Whether participants can join a meeting directly from their mobile browser. -
language_interpretationobject— Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.-
allow_participants_to_speak_in_listening_channelboolean— Whether to allow participants to speak in listening channel. -
allow_up_to_25_custom_languages_when_scheduling_meetingsboolean— Whether to allow up to 25 custom languages when scheduling meetings. -
custom_languagesarray— A list of the user-defined supported languages.Items:
string -
enableboolean— Whether hosts can assign participants as interpreters who can interpret one language into another in real-time. -
enable_language_interpretation_by_defaultboolean— Whether enable language interpretation by default. -
languagesarray, possible values:"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"— A list of system-supported languages.Items:
string
-
-
live_streaming_facebookboolean— Whether Facebook livestreaming is enabled. -
live_streaming_youtubeboolean— Whether YouTube livestreaming is enabled. -
manual_captioningobject— Information about manual captioning settings.-
allow_to_typeboolean— Whether the host can manually caption or let the host assign a participant to provide manual captioning. -
auto_generated_captionsboolean— Whether Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB) is enabled. -
full_transcriptboolean— Whether to enable the viewing of full transcripts in the in-meeting side panel. -
manual_captionsboolean— Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled. -
save_captionsboolean— Whether participants can [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. -
third_party_captioning_serviceboolean— Whether the use of an API token to integrate with a [third-party device](https://support.zoom.us/hc/en-us/articles/115002212983) for closed captioning is enabled.
-
-
meeting_pollingobject— Information about the account's meeting polling settings.-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a meeting. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
meeting_question_answerboolean— Allow participants to ask questions for the host and participants to answer. -
meeting_reactionsboolean— 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. -
meeting_reactions_emojisstring, possible values:"all", "selected"— 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) -
meeting_surveyboolean— Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. -
non_verbal_feedbackboolean— Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel. -
only_host_view_device_listboolean— Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host. -
original_audioboolean— Whether users can toggle the [**Use Original Audio**](https://support.zoom.us/hc/en-us/articles/115003279466-Using-and-preserving-original-sound-in-a-meeting) setting during a meeting. -
participants_share_simultaneouslystring, possible values:"multiple", "one"— Indicates how many participants can screen share at the same time. The value can be one of the following:<br> one: Only one participant can screen share at a time .<br> multiple: Multiple participants can screen share simultaneously (dual monitors recommended). -
pollingboolean— Whether the [**Polls**](https://support.zoom.us/hc/en-us/articles/4412324684685) feature is included in the meeting controls. This allows the host to survey the attendees. -
post_meeting_feedbackboolean— Whether an [post-meeting feedback survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting) is enabled for the end of each meeting. -
private_chatboolean— Whether meeting participants can send private 1:1 chat message other meeting participants. -
record_play_own_voiceboolean— Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes. -
remote_controlboolean— During screen sharing, whether the person who is presenting can let others control the shared content. -
remote_supportboolean— Whether the meeting host can provide 1:1 remote support to another participant. -
request_permission_to_unmuteboolean— 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) setting is enabled. -
screen_sharingboolean— Whether hosts and participants can share their screen or content during meetings. -
sending_default_email_invitesboolean— Whether users can invite participants by email only by default. -
show_a_join_from_your_browser_linkboolean— Whether participants can 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. -
show_device_listboolean— Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users. -
show_meeting_control_toolbarboolean— Whether to always display the meeting controls toolbar during a meeting. -
sign_language_interpretationobject— Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.-
custom_languagesarray— A list of user-defined supported languages.Items:
string -
enableboolean— Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time. -
enable_sign_language_interpretation_by_defaultboolean— Whether to enable sign language interpretation view by default in scheduler. -
languagesarray— A list of system-supported languages.Items:
string, possible values:"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"
-
-
slide_controlboolean— 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. -
stereo_audioboolean— Whether users can select stereo audio during a meeting. -
unchecked_data_center_regionsarray, possible values:"EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"— 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.Items:
string -
use_html_format_emailboolean— Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin. -
virtual_backgroundboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
virtual_background_settingsobject— Information about the Virtual Background settings.-
allow_upload_customboolean— Whether users can upload custom Virtual Backgrounds. -
allow_videosboolean— Whether users can upload videos for Virtual Backgrounds. -
enableboolean— Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled. -
filesarray— Information about the Virtual Background files.Items:
-
idstring— The file's ID. -
is_defaultboolean— Whether the file is a default Virtual Background file. -
namestring— The file's name. -
sizeinteger— The file's size, in bytes. -
typestring— The file type.
-
-
-
waiting_roomboolean— Whether participants cannot join a meeting until the host admits them from the waiting room. -
webinar_chatobject— Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings.-
allow_attendees_chat_withinteger, possible values:1, 2, 3— The webinar attendees' chat permissions: * 1 — Attendees cannot use chat. * 2 — Attendees can only chat with the host and panelists. * 3 — Attendees can chat with everyone. -
allow_auto_save_local_chat_fileboolean— Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends. -
allow_panelists_chat_withinteger, possible values:1, 2— The webinar panelists chat permissions: * 1 — Panelists can only chat with the host and panelists. * 2 — The panelists can chat with everyone. -
allow_panelists_send_direct_messageboolean— Whether webinar panelists can send direct messages to other panelists. -
allow_users_save_chatsinteger, possible values:0, 1, 2— Whether webinar attendees can save chats: * 0 — Attendees cannot save chats. * 1 — Attendees can only save host and panelist chats. * 2 — Attendees can save all chats. -
default_attendees_chat_withinteger, possible values:1, 2— By default, webinar attendees can chat with: * 1 — Host and all panelists. * 2 — Everyone. -
enableboolean— Whether in-webinar chat is enabled.
-
-
webinar_live_streamingobject-
custom_service_instructionsstring— The specific instructions to allow your account's meeting hosts to configure a custom livestream. -
enableboolean— Whether webinar livestreaming is enabled. -
live_streaming_reminderboolean— Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol). -
live_streaming_servicearray— The available livestreaming services: * facebook * workplace_by_facebook * youtube * custom_live_streaming_serviceItems:
string, possible values:"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"
-
-
webinar_pollingobject-
advanced_pollsboolean— Whether hosts can 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. -
allow_alternative_host_to_add_editboolean— Whether alternative hosts can add or edit polls and quizzes. -
allow_host_to_upload_imageboolean— Whether to allow host to upload an image for each question. -
enableboolean— Whether the host can add polls before or during a webinar. -
manage_saved_polls_and_quizzesboolean— Whether to allow users to manage saved polls and quizzes from Meetings -
require_answers_to_be_anonymousboolean— Whether to require answers to be anonymous.
-
-
webinar_question_answerboolean— Whether attendees can ask the host and panelists questions in the webinar. -
webinar_reactionsboolean— Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429). -
webinar_surveyboolean— Whether the host can present surveys to attendees once a webinar has ended. -
whiteboardboolean— Whether participants can share a whiteboard that includes annotation tools. -
who_can_share_screenstring, possible values:"host", "all"— The users who share their screen or content during meetings: * host — Only the host can share their screen. * all — Hosts and panelists can share their screen. Attendees **cannot** share their screen. -
who_can_share_screen_when_someone_is_sharingstring, possible values:"host", "all"— The users who can start sharing screen when someone else in the meeting is sharing their screen: * host — Only the host can share the screen when someone else is sharing. * all — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing. -
workplace_by_facebookboolean— Whether Workplace by Facebook is enabled.
-
-
meeting_securityobject-
auto_securityboolean— 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. -
block_user_domainboolean— Whether users in specific domains are blocked from joining meetings and webinars. -
block_user_domain_listarray— A list of blocked domains.Items:
string -
chat_etiquette_toolobject— Information about the Chat Etiquette Tool.-
enableboolean— Whether the **Chat Etiquette Tool** is enabled. -
policiesarray— Information about the defined **Chat Etiquette Tool** policies.Items:
-
descriptionstring— The policy's description. -
idstring— The policy ID. -
is_lockedboolean— Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy. -
keywordsarray— A list of defined rule keywords.Items:
string -
namestring— The policy name. -
regular_expressionstring— The regular expression to match to the content of chat messages. -
statusstring, possible values:"activated", "deactivated"— The policy's current status: * activated — Activated. * deactivated — Deactivated. -
trigger_actioninteger, possible values:1, 2— The policy's trigger action: * 1 — Ask the user to confirm before they send the message. * 2 — Block the user's message.
-
-
-
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password. -
encryption_typestring, possible values:"enhanced_encryption", "e2ee"— The type of encryption used when starting 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. 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. -
end_to_end_encrypted_meetingsboolean— Whether end-to-end encryption is enabled for meetings. -
meeting_passwordboolean— 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. -
meeting_password_requirementobject— 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).-
consecutive_characters_lengthinteger, possible values:0, 4, 5, 6, 7, 8— 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. -
have_letterboolean— Whether the password must contain at least one letter character. -
have_numberboolean— Whether the password must contain at least one numeric character. -
have_special_characterboolean— Whether the password must contain at least one special character. For example, !, @, and/or # characters. -
have_upper_and_lower_charactersboolean— Whether the password must include uppercase and lowercase characters. -
lengthinteger— The password's minimum length. -
only_allow_numericboolean— Whether the password must contain **only** numeric characters. -
weak_enhance_detectionboolean— Whether users will be informed when the provided password is weak.
-
-
only_authenticated_can_join_from_webclientboolean— Whether only authenticated users can join meetings from the web client. -
phone_passwordboolean— 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. -
pmi_passwordboolean— Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected. -
require_password_for_scheduled_meetingboolean— Whether a password is required for meetings that have already been scheduled. -
require_password_for_scheduled_webinarboolean— Whether a password is required for webinars that have already been scheduled. -
waiting_roomboolean— 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. -
waiting_room_settingsobject— Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings.-
participants_to_place_in_waiting_roominteger, possible values:0, 1, 2— 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). -
users_who_can_admit_participants_from_waiting_roominteger, possible values:0, 1— 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. -
whitelisted_domains_for_waiting_roomstring— If the participants_to_place_in_waiting_room field is 2, a comma-separated list of the domains that can bypass the Waiting Room (for example, example.com,example2.com).
-
-
webinar_passwordboolean— Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
-
-
other_optionsobject-
allow_users_contact_support_via_chatboolean— Whether the [**Allow users to contact Zoom's Support via Chat**](https://support.zoom.us/hc/en-us/articles/360059513751-Allowing-users-to-contact-Zoom-Support-via-Chat) setting is enabled. -
blur_snapshotboolean— Whether iOS blurs screenshots in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps. -
webinar_registration_optionsobject— Webinar registration options.-
allow_host_to_enable_social_share_buttonsboolean— Allow host to enable "Show social share buttons on registration page"
-
-
-
profileobject-
recording_storage_locationobject— Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings.-
allowed_valuesarray— A list of the countries where the group's recorded content is stored.Items:
string -
valuestring— The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).
-
-
-
recordingobject-
account_user_access_recordingboolean— Whether cloud recordings are accessible to account members. -
archiveobject— The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings.-
enableboolean— Whether the **Meeting and Webinar Archiving solution** feature is enabled. This feature must be enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003). -
settingsobject-
audio_fileboolean— Whether audio is included in the archive. -
cc_transcript_fileboolean— Whether closed captions are included in the archive. -
chat_fileboolean— Whether chat files are included in the archive. -
chat_with_sender_emailboolean— Whether user emails are included in the chat file. -
video_fileboolean— Whether video is included in the archive.
-
-
typeinteger, possible values:1, 2, 3— The type archiving: * 1 — Only archive meetings. * 2 — Only archive webinars. * 3 — Archive both meetings and webinars.
-
-
auto_recordingboolean— Whether meetings are automatically recorded when they begin. -
cloud_recordingboolean— Whether hosts can record and save the meetings and webinars in the cloud. -
cloud_recording_downloadboolean— Whether anyone with a link to the cloud recording can download the file. -
cloud_recording_download_hostboolean— Whether the host with a link to the cloud recording can download the file. -
display_participant_nameboolean— Whether participants' names display in the recording. -
host_delete_cloud_recordingboolean— Whether the host can delete cloud recordings. If false, only the admin can delete cloud recordings. -
ip_address_access_controlobject— Information about the cloud recording access from specific IP address ranges.-
enableboolean— Whether cloud recording access is only available for a specific range of IP addresses. -
ip_addresses_or_rangesstring— The IP addresses or ranges with access to the cloud recordings.
-
-
local_recordingboolean— Whether hosts and participants can record meetings to a local file. -
optimize_recording_for_3rd_party_video_editorboolean— Whether recordings are optimized for a third-party video editor. This can increase the file size and the time it takes to generate recording files. -
prevent_host_access_recordingboolean— Whether meeting hosts do not have access to their meeting cloud recordings. Only the admins who have recording management privilege can access them. -
record_audio_fileboolean— Whether a single audio file is recorded for all participants. -
record_audio_file_each_participantboolean— Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files. -
record_files_separatelyobject— 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.-
active_speakerboolean— Whether recording only the active speaker is enabled. -
gallery_viewboolean— Whether recording only the gallery view is enabled. -
shared_screenboolean— Whether recording only shared screen is enabled.
-
-
record_gallery_viewboolean— Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen. -
record_speaker_viewboolean— Whether to record the active speaker when screen sharing is active. -
recording_audio_transcriptboolean— Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled. -
recording_highlightboolean— Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled. -
recording_thumbnailsboolean— Whether thumbnails of the presenter are recorded when they are sharing their screen. -
save_chat_textboolean— Whether chat messages are saved from meetings or webinars. -
save_close_captionboolean— Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file. -
save_panelist_chatboolean— Whether panelist chats are saved to the recording. -
save_poll_resultsboolean— Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar. -
show_timestampboolean— Whether a timestamp is included in the recording. -
smart_recordingobject— 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.-
create_next_stepsboolean— By selecting this option, there will be a summary of actions to take after the recorded meeting. -
create_recording_highlightsboolean— 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. -
create_smart_chaptersboolean— By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
-
-
-
schedule_meetingobject-
always_display_zoom_meeting_as_topicobject— 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.-
display_topic_for_scheduled_meetingsboolean— Whether "Zoom Meeting" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always display "Zoom Meeting" as the meeting topic** setting is enabled.
-
-
always_display_zoom_webinar_as_topicobject— 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.-
display_topic_for_scheduled_webinarsboolean— Whether "Zoom Webinar" displays as the topic for already-scheduled meetings. -
enableboolean— Whether the **Always show "Zoom Webinar" as the webinar topic** setting is enabled.
-
-
audio_typeboolean— Whether participants can join only the audio portion of meetings. -
embed_password_in_join_linkboolean— Whether the meeting password is encrypted and included in the meeting links that allow participants to join with just one click without having to enter the password. -
force_pmi_jbh_passwordboolean— Whether passwords are required to join before the host in personal meetings. -
host_videoboolean— Whether host video defaults to on when they join meetings. -
join_before_hostboolean— Whether participants can join meetings before the host. -
mute_upon_entryboolean— Whether all participants are automatically muted when they join meetings. -
participant_videoboolean— Whether participant video defaults to on when they join meetings. -
personal_meetingboolean— Whether the [**Personal Meeting ID (PMI)**](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI) feature is enabled. If disabled, meetings that were previously-scheduled via PMI will need to be manually updated. For Zoom Phone, if a user has been assigned a desk phone, the **Elevate to Zoom Meeting** setting is disabled. -
pstn_password_protectedboolean— Whether new passwords are generated and sent for newly-scheduled or edited meetings. -
require_password_for_instant_meetingsboolean— Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled. -
require_password_for_pmi_meetingsstring, possible values:"none", "all", "jbh_only"— Whether participants are required to enter a password for PMI meetings: * none — Do not require a password for PMI meetings. * all — Require participants to enter password for all PMI-enabled meetings. * jbh_only — Only require a password for meetings where the **Join Before Host** setting is enabled. -
require_password_for_scheduled_meetingsboolean— Whether a password is required for meetings which have already been scheduled. -
require_password_for_scheduling_new_meetingsboolean— Whether a password is generated when a host schedules a new meeting. Participants are required to enter the password before they can join the meeting. -
upcoming_meeting_reminderboolean— Whether desktop notification are sent for upcoming meetings. -
use_pmi_for_instant_meetingsboolean— Whether PMI is enabled for all instant meetings. -
use_pmi_for_schedule_meetingsboolean— Whether a PMI is enabled for all scheduled meetings.
-
-
telephonyobject-
audio_conference_infostring— Information about the third-party audio configuration. -
telephony_regionsobject— The telephony regions from which participants call in to or call from.-
selection_valuesstring— The account's selected telephony regions that indicate where most participants call into or call from during a meeting.
-
-
third_party_audioboolean— Whether users can join meetings using the existing third party audio configurations.
-
-
-
-
operator(required)string, format:email— The email address of the user that updated the group's settings. -
operator_id(required)string— The user ID of the user that updated the group's settings. -
time_stampinteger, format:int64— A timestamp that indicates when the group's settings were updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"display_number": "",
"number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 7777 777",
"number": "7777 777"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"recording_available_reminder_alternative_hosts": true,
"recording_available_reminder_schedulers": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_participants_chat_with": 1,
"allow_show_zoom_windows": true,
"allow_users_save_chats": 1,
"annotation": true,
"auto_answer": true,
"auto_saving_chat": true,
"breakout_room": true,
"breakout_room_schedule": true,
"chat": true,
"meeting_question_answer": true,
"closed_caption": true,
"closed_captioning": {
"auto_transcribing": true,
"enable": true,
"save_caption": true,
"third_party_captioning_service": true,
"view_full_transcript": true
},
"co_host": true,
"custom_data_center_regions": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"data_center_regions": [
"AU"
],
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"group_hd": true,
"join_from_desktop": true,
"join_from_mobile": true,
"language_interpretation": {
"custom_languages": [
""
],
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"enable": true,
"languages": "English"
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"live_streaming_facebook": true,
"live_streaming_youtube": true,
"manual_captioning": {
"allow_to_type": true,
"auto_generated_captions": true,
"full_transcript": true,
"manual_captions": true,
"save_captions": true,
"third_party_captioning_service": true
},
"meeting_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"only_host_view_device_list": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"record_play_own_voice": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_device_list": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"unchecked_data_center_regions": "EU",
"use_html_format_email": true,
"virtual_background": true,
"virtual_background_settings": {
"allow_upload_custom": true,
"allow_videos": true,
"enable": true,
"files": [
{
"id": "",
"is_default": true,
"name": "",
"size": 1,
"type": ""
}
]
},
"waiting_room": true,
"webinar_chat": {
"allow_attendees_chat_with": 1,
"allow_auto_save_local_chat_file": true,
"allow_panelists_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"default_attendees_chat_with": 1,
"enable": true
},
"webinar_live_streaming": {
"custom_service_instructions": "",
"enable": true,
"live_streaming_reminder": true,
"live_streaming_service": [
"facebook"
]
},
"webinar_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"webinar_question_answer": true,
"webinar_survey": true,
"whiteboard": true,
"who_can_share_screen": "host",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"workplace_by_facebook": true
},
"other_options": {
"allow_users_contact_support_via_chat": true,
"blur_snapshot": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"profile": {
"recording_storage_location": {
"allowed_values": [
""
],
"value": ""
}
},
"recording": {
"account_user_access_recording": true,
"archive": {
"enable": true,
"settings": {
"audio_file": true,
"cc_transcript_file": true,
"chat_file": true,
"chat_with_sender_email": true,
"video_file": true
},
"type": 1
},
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"display_participant_name": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"local_recording": true,
"optimize_recording_for_3rd_party_video_editor": true,
"prevent_host_access_recording": true,
"record_audio_file": true,
"record_audio_file_each_participant": true,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"record_gallery_view": true,
"record_speaker_view": true,
"recording_audio_transcript": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"recording_thumbnails": true,
"save_chat_text": true,
"save_close_caption": true,
"save_panelist_chat": true,
"save_poll_results": true,
"show_timestamp": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"mute_upon_entry": true,
"participant_video": true,
"personal_meeting": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": "none",
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_schedule_meetings": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
}
},
"telephony": {
"audio_conference_info": "",
"telephony_regions": {
"selection_values": ""
},
"third_party_audio": true
},
"meeting_security": {
"auto_security": true,
"block_user_domain": true,
"block_user_domain_list": [
""
],
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "",
"id": "",
"is_locked": true,
"keywords": [
""
],
"name": "",
"regular_expression": "",
"status": "activated",
"trigger_action": 1
}
]
},
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"meeting_password_requirement": {
"consecutive_characters_length": 0,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"have_upper_and_lower_characters": true,
"length": 1,
"only_allow_numeric": true,
"weak_enhance_detection": true
},
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"require_password_for_scheduled_meeting": true,
"require_password_for_scheduled_webinar": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"users_who_can_admit_participants_from_waiting_room": 0,
"whitelisted_domains_for_waiting_room": ""
},
"webinar_password": true
},
"chat": {
"share_files": {
"enable": true,
"share_option": true
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_search_others_options": "1,3",
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"id": "aefwf23dsv;sdo-khuity8",
"status": "Activated"
}
]
},
"send_data_to_third_party_archiving_service": {
"enable": true
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"display_number": "",
"number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 7777 777",
"number": "7777 777"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
}
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"recording_available_reminder_alternative_hosts": true,
"recording_available_reminder_schedulers": true,
"schedule_for_reminder": true
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_participants_chat_with": 1,
"allow_show_zoom_windows": true,
"allow_users_save_chats": 1,
"annotation": true,
"auto_answer": true,
"auto_saving_chat": true,
"breakout_room": true,
"breakout_room_schedule": true,
"chat": true,
"meeting_question_answer": true,
"closed_caption": true,
"closed_captioning": {
"auto_transcribing": true,
"enable": true,
"save_caption": true,
"third_party_captioning_service": true,
"view_full_transcript": true
},
"co_host": true,
"custom_data_center_regions": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"data_center_regions": [
"AU"
],
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"e2e_encryption": true,
"entry_exit_chime": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"group_hd": true,
"join_from_desktop": true,
"join_from_mobile": true,
"language_interpretation": {
"custom_languages": [
""
],
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"enable": true,
"languages": "English"
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"live_streaming_facebook": true,
"live_streaming_youtube": true,
"manual_captioning": {
"allow_to_type": true,
"auto_generated_captions": true,
"full_transcript": true,
"manual_captions": true,
"save_captions": true,
"third_party_captioning_service": true
},
"meeting_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"meeting_survey": true,
"non_verbal_feedback": true,
"only_host_view_device_list": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"record_play_own_voice": true,
"remote_control": true,
"remote_support": true,
"request_permission_to_unmute": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_a_join_from_your_browser_link": true,
"show_device_list": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"unchecked_data_center_regions": "EU",
"use_html_format_email": true,
"virtual_background": true,
"virtual_background_settings": {
"allow_upload_custom": true,
"allow_videos": true,
"enable": true,
"files": [
{
"id": "",
"is_default": true,
"name": "",
"size": 1,
"type": ""
}
]
},
"waiting_room": true,
"webinar_chat": {
"allow_attendees_chat_with": 1,
"allow_auto_save_local_chat_file": true,
"allow_panelists_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"default_attendees_chat_with": 1,
"enable": true
},
"webinar_live_streaming": {
"custom_service_instructions": "",
"enable": true,
"live_streaming_reminder": true,
"live_streaming_service": [
"facebook"
]
},
"webinar_polling": {
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true,
"enable": true
},
"webinar_question_answer": true,
"webinar_survey": true,
"whiteboard": true,
"who_can_share_screen": "host",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple",
"workplace_by_facebook": true
},
"other_options": {
"allow_users_contact_support_via_chat": true,
"blur_snapshot": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"profile": {
"recording_storage_location": {
"allowed_values": [
""
],
"value": ""
}
},
"recording": {
"account_user_access_recording": true,
"archive": {
"enable": true,
"settings": {
"audio_file": true,
"cc_transcript_file": true,
"chat_file": true,
"chat_with_sender_email": true,
"video_file": true
},
"type": 1
},
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"display_participant_name": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"local_recording": true,
"optimize_recording_for_3rd_party_video_editor": true,
"prevent_host_access_recording": true,
"record_audio_file": true,
"record_audio_file_each_participant": true,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"record_gallery_view": true,
"record_speaker_view": true,
"recording_audio_transcript": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"recording_thumbnails": true,
"save_chat_text": true,
"save_close_caption": true,
"save_panelist_chat": true,
"save_poll_results": true,
"show_timestamp": true
},
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"force_pmi_jbh_password": true,
"host_video": true,
"join_before_host": true,
"mute_upon_entry": true,
"participant_video": true,
"personal_meeting": true,
"pstn_password_protected": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": "none",
"require_password_for_scheduled_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"upcoming_meeting_reminder": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_schedule_meetings": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
}
},
"telephony": {
"audio_conference_info": "",
"telephony_regions": {
"selection_values": ""
},
"third_party_audio": true
},
"meeting_security": {
"auto_security": true,
"block_user_domain": true,
"block_user_domain_list": [
""
],
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "",
"id": "",
"is_locked": true,
"keywords": [
""
],
"name": "",
"regular_expression": "",
"status": "activated",
"trigger_action": 1
}
]
},
"embed_password_in_join_link": true,
"encryption_type": "enhanced_encryption",
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"meeting_password_requirement": {
"consecutive_characters_length": 0,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"have_upper_and_lower_characters": true,
"length": 1,
"only_allow_numeric": true,
"weak_enhance_detection": true
},
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"require_password_for_scheduled_meeting": true,
"require_password_for_scheduled_webinar": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"users_who_can_admit_participants_from_waiting_room": 0,
"whitelisted_domains_for_waiting_room": ""
},
"webinar_password": true
},
"chat": {
"share_files": {
"enable": true,
"share_option": true
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_search_others_options": "1,3",
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"id": "aefwf23dsv;sdo-khuity8",
"status": "Activated"
}
]
},
"send_data_to_third_party_archiving_service": {
"enable": true
}
}
}
}
}
}
POST user.disassociated
- Method:
POST - Path:
user.disassociated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was disassociated. -
object(required)object— Information about the disassociated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that disassociated the user. -
operator_id(required)string— The user ID of the user that disassociated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user was disassociated. -
object(required)object— Information about the disassociated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that disassociated the user. -
operator_id(required)string— The user ID of the user that disassociated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
POST group.updated
- Method:
POST - Path:
group.updated - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
old_object(required)object— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
namestring— The modified field its original value.
-
-
operator(required)string, format:email— The email address of the user that updated the group. -
operator_id(required)string— The user ID of the user that updated the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
},
"old_object": {
"id": "",
"name": ""
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
old_object(required)object— Information about the group's previous settings.-
id(required)string— The updated group's ID. -
namestring— The modified field its original value.
-
-
operator(required)string, format:email— The email address of the user that updated the group. -
operator_id(required)string— The user ID of the user that updated the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was updated, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
},
"old_object": {
"id": "",
"name": ""
}
}
}
POST user.presence_status_updated
- Method:
POST - Path:
user.presence_status_updated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— Webhook event name. For example, 'user.presence_status_updated'. -
event_ts(required)integer, format:int64— The timestamp when the event occurred, in Unix epoch milliseconds. For example, 1712145600000. -
payload(required)object-
account_id(required)string— The unique account ID of the user's account owner. For example, 'Efg123AbCd'. -
object(required)object— Information about the user whose presence status changed.-
date_time(required)string, format:date-time— The date and time when the user's presence status was updated, in RFC 3339 format. For example, '2026-04-03T15:19:00Z'. -
email(required)string, format:email— The user's email address. For example, 'user@example.com'. -
id(required)string— The user's unique identifier. For example, 'aBc123XyZ'. -
presence_status(required)string, possible values:"Available", "Away", "Do_Not_Disturb", "In_Meeting", "Presenting", "On_Phone_Call", "In_Calendar_Event", "Offline", "Busy", "Mobile_signed_in"— The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488): * Available — Online. * Away — Away. * Do_Not_Disturb — Do not disturb. * In_Meeting — In a Zoom meeting. * Presenting — Sharing their screen in a Zoom meeting. * On_Phone_Call — On a Zoom Phone call. * In_Calendar_Event — In a calendar event. * Offline - Signed out or inactive. * Mobile_signed_in — Desktop device is offline, but mobile device is signed in. -
appobject— Information about the app that triggered the event.-
presence_status(required)string, possible values:"Available", "Away", "Do_Not_Disturb", "In_Meeting", "Presenting", "On_Phone_Call", "In_Calendar_Event", "Offline", "Busy"— The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488) on this app: * Available — Online. * Away — Away. * Do_Not_Disturb — Do not disturb. * In_Meeting — In a Zoom meeting. * Presenting — Sharing their screen in a Zoom meeting. * On_Phone_Call — On a Zoom Phone call. * In_Calendar_Event — In a calendar event. * Offline - Signed out or inactive. -
type(required)string, possible values:"desktop", "mobile", "pad", "pzr"— The app type that reported the presence status: * desktop — Desktop client. * mobile - Mobile device. * pad - Tablet device. * pzr — Personal Zoom Room.
-
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"date_time": "",
"email": "",
"id": "",
"presence_status": "Available",
"app": {
"type": "desktop",
"presence_status": "Available"
}
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— Webhook event name. For example, 'user.presence_status_updated'. -
event_ts(required)integer, format:int64— The timestamp when the event occurred, in Unix epoch milliseconds. For example, 1712145600000. -
payload(required)object-
account_id(required)string— The unique account ID of the user's account owner. For example, 'Efg123AbCd'. -
object(required)object— Information about the user whose presence status changed.-
date_time(required)string, format:date-time— The date and time when the user's presence status was updated, in RFC 3339 format. For example, '2026-04-03T15:19:00Z'. -
email(required)string, format:email— The user's email address. For example, 'user@example.com'. -
id(required)string— The user's unique identifier. For example, 'aBc123XyZ'. -
presence_status(required)string, possible values:"Available", "Away", "Do_Not_Disturb", "In_Meeting", "Presenting", "On_Phone_Call", "In_Calendar_Event", "Offline", "Busy", "Mobile_signed_in"— The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488): * Available — Online. * Away — Away. * Do_Not_Disturb — Do not disturb. * In_Meeting — In a Zoom meeting. * Presenting — Sharing their screen in a Zoom meeting. * On_Phone_Call — On a Zoom Phone call. * In_Calendar_Event — In a calendar event. * Offline - Signed out or inactive. * Mobile_signed_in — Desktop device is offline, but mobile device is signed in. -
appobject— Information about the app that triggered the event.-
presence_status(required)string, possible values:"Available", "Away", "Do_Not_Disturb", "In_Meeting", "Presenting", "On_Phone_Call", "In_Calendar_Event", "Offline", "Busy"— The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488) on this app: * Available — Online. * Away — Away. * Do_Not_Disturb — Do not disturb. * In_Meeting — In a Zoom meeting. * Presenting — Sharing their screen in a Zoom meeting. * On_Phone_Call — On a Zoom Phone call. * In_Calendar_Event — In a calendar event. * Offline - Signed out or inactive. -
type(required)string, possible values:"desktop", "mobile", "pad", "pzr"— The app type that reported the presence status: * desktop — Desktop client. * mobile - Mobile device. * pad - Tablet device. * pzr — Personal Zoom Room.
-
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"date_time": "",
"email": "",
"id": "",
"presence_status": "Available",
"app": {
"type": "desktop",
"presence_status": "Available"
}
}
}
}
POST user.activated
- Method:
POST - Path:
user.activated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user's account owner. -
object(required)object— Information about the activated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that activated the user. -
operator_id(required)string— The user ID of the user that activated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user's account owner. -
object(required)object— Information about the activated user.-
email(required)string, format:email— The user's email address. -
first_name(required)string— The user's first name. -
id(required)string— The user's ID. -
last_name(required)string— The user's last name. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed.
-
-
operator(required)string, format:email— The email address of the user that activated the user. -
operator_id(required)string— The user ID of the user that activated the user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"email": "",
"type": 1
}
}
}
POST user.signed_in
- Method:
POST - Path:
user.signed_in - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user signed in. -
object(required)object— Information about the user.-
client_type(required)string, possible values:"browser", "mac", "win", "iphone", "android", "ipad", "chromeos", "linux"— The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): * browser — Browser. * mac — MacOS. * win — Windows. * iphone — iPhone. * android — Android. * ipad — iPad. * chromeos — Chrome OS. * linux — Linux. -
date_time(required)string, format:date-time— The date and time at which the user signed in. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
login_type(required)integer, possible values:0, 1, 100, 101— The method the user logged in with: * 0 — Facebook. * 1 — Google. * 100 — Zoom. * 101 — Single Sign-On (SSO). -
version(required)string— The [Zoom client version number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407). If the user signs in via browser, the value of this field will return a - value.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"client_type": "browser",
"date_time": "",
"email": "",
"version": "",
"login_type": 0
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user signed in. -
object(required)object— Information about the user.-
client_type(required)string, possible values:"browser", "mac", "win", "iphone", "android", "ipad", "chromeos", "linux"— The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): * browser — Browser. * mac — MacOS. * win — Windows. * iphone — iPhone. * android — Android. * ipad — iPad. * chromeos — Chrome OS. * linux — Linux. -
date_time(required)string, format:date-time— The date and time at which the user signed in. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
login_type(required)integer, possible values:0, 1, 100, 101— The method the user logged in with: * 0 — Facebook. * 1 — Google. * 100 — Zoom. * 101 — Single Sign-On (SSO). -
version(required)string— The [Zoom client version number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407). If the user signs in via browser, the value of this field will return a - value.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"client_type": "browser",
"date_time": "",
"email": "",
"version": "",
"login_type": 0
}
}
}
POST user.signed_out
- Method:
POST - Path:
user.signed_out - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user signed out. -
object(required)object— Information about the user.-
client_type(required)string, possible values:"browser", "mac", "win", "iphone", "android", "ipad", "chromeos", "linux"— The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): * browser — Browser. * mac — MacOS. * win — Windows. * iphone — iPhone. * android — Android. * ipad — iPad. * chromeos — Chrome OS. * linux — Linux. -
date_time(required)string, format:date-time— The date and time at which the user signed out. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
login_type(required)integer, possible values:0, 1, 100, 101— The method the user logged in with: * 0 — Facebook. * 1 — Google. * 100 — Zoom. * 101 — Single Sign-On (SSO). -
version(required)string— The [Zoom client version number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407). If the user signs in via browser, the value of this field will return a - value.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"client_type": "browser",
"date_time": "",
"email": "",
"version": "",
"login_type": 0
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the account from which the user signed out. -
object(required)object— Information about the user.-
client_type(required)string, possible values:"browser", "mac", "win", "iphone", "android", "ipad", "chromeos", "linux"— The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): * browser — Browser. * mac — MacOS. * win — Windows. * iphone — iPhone. * android — Android. * ipad — iPad. * chromeos — Chrome OS. * linux — Linux. -
date_time(required)string, format:date-time— The date and time at which the user signed out. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
login_type(required)integer, possible values:0, 1, 100, 101— The method the user logged in with: * 0 — Facebook. * 1 — Google. * 100 — Zoom. * 101 — Single Sign-On (SSO). -
version(required)string— The [Zoom client version number](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407). If the user signs in via browser, the value of this field will return a - value.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"id": "",
"client_type": "browser",
"date_time": "",
"email": "",
"version": "",
"login_type": 0
}
}
}
POST user.personal_notes_updated
- Method:
POST - Path:
user.personal_notes_updated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user's account owner. -
object(required)object— Information about the user.-
date_time(required)string, format:date-time— The date and time at which the user's personal note was updated. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
personal_notes(required)string— The updated [personal note](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066608).
-
-
old_object(required)object— Information about the user's previous personal note.-
personal_notes(required)string— The previous personal note entry.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"date_time": "",
"email": "",
"id": "",
"personal_notes": ""
},
"old_object": {
"personal_notes": ""
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user's account owner. -
object(required)object— Information about the user.-
date_time(required)string, format:date-time— The date and time at which the user's personal note was updated. -
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
personal_notes(required)string— The updated [personal note](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066608).
-
-
old_object(required)object— Information about the user's previous personal note.-
personal_notes(required)string— The previous personal note entry.
-
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"date_time": "",
"email": "",
"id": "",
"personal_notes": ""
},
"old_object": {
"personal_notes": ""
}
}
}
POST group.member_added
- Method:
POST - Path:
group.member_added - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
members(required)array— Information about the members added to the group.Items:
-
emailstring, format:email— The member's email address. -
idstring— The member's user ID.
-
-
-
operator(required)string, format:email— The email address of the user that added members to the group. -
operator_id(required)string— The user ID of the user that added members to the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's members were added, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"members": [
{
"id": "",
"email": ""
}
]
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
members(required)array— Information about the members added to the group.Items:
-
emailstring, format:email— The member's email address. -
idstring— The member's user ID.
-
-
-
operator(required)string, format:email— The email address of the user that added members to the group. -
operator_id(required)string— The user ID of the user that added members to the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group's members were added, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"members": [
{
"id": "",
"email": ""
}
]
}
}
}
POST user.updated
- Method:
POST - Path:
user.updated - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the user. -
object(required)object— Information about the updated user.-
id(required)string— The user's ID. -
companystring— The user's company. -
custom_attributesarray— Information about the user's custom attributes. This field only returns if users are assigned custom attributes.Items:
-
key(required)string— The custom attribute's unique ID. -
name(required)string— The custom attribute's name. -
value(required)integer— The custom attribute's value.
-
-
deptstring— The user's department. -
display_namestring— The user's display name. -
emailstring, format:email— The user's email address. -
first_namestring— The user's first name. -
host_keystring— The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063). -
languagestring— The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475). -
last_namestring— The user's last name. -
phone_countrystring— **Note:** This field is **deprecated**. Use the phone_numbers field. The user's phone number country. -
phone_numberstring— The user's phone number. -
pic_urlstring— The user's profile picture URL. -
pmiinteger, format:int64— The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271). -
primary_group_idstring— The user's primary group id, the field returns values if a user's primary group is changed. -
rolestring— The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983). -
settingsobject— The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting).-
featureobject— The user's updated profile features.-
large_meeting_capacityinteger— The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis. -
webinarboolean— Whether the Webinar plan is enabled for the user. -
webinar_capacityinteger— The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis.
-
-
large_meetingstring— Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user. -
meeting_capacityinteger— The user's meeting capacity.
-
-
timezonestring— The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api). -
typeinteger, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
use_pmiboolean— Whether a PMI will be used instead of an auto-generated meeting ID. -
vanity_namestring— The user's personal meeting room name.
-
-
old_objectobject— Information about the user's previous value.-
id(required)string— The user's ID. -
companystring— The user's company. -
custom_attributesarray— Information about the user's custom attributes. This field only returns if users are assigned custom attributes.Items:
-
key(required)string— The custom attribute's unique ID. -
name(required)string— The custom attribute's name. -
value(required)integer— The custom attribute's value.
-
-
deptstring— The user's department. -
display_namestring— The user's display name. -
emailstring, format:email— The user's email address. -
first_namestring— The user's first name. -
host_keystring— The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063). -
languagestring— The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475). -
last_namestring— The user's last name. -
phone_countrystring— **Note:** This field is **deprecated**. Use the phone_numbers field. The user's phone number country. -
phone_numberstring— The user's phone number. -
pic_urlstring— The user's profile picture URL. -
pmiinteger, format:int64— The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271). -
primary_group_idstring— The user's primary group id, the field returns values if a user's primary group is changed. -
rolestring— The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983). -
settingsobject— The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting).-
featureobject— The user's updated profile features.-
large_meeting_capacityinteger— The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis. -
webinarboolean— Whether the Webinar plan is enabled for the user. -
webinar_capacityinteger— The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis.
-
-
large_meetingstring— Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user. -
meeting_capacityinteger— The user's meeting capacity.
-
-
timezonestring— The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api). -
typeinteger, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
use_pmiboolean— Whether a PMI will be used instead of an auto-generated meeting ID. -
vanity_namestring— The user's personal meeting room name.
-
-
operationstring, possible values:"change_password", "sign_out_from_all_devices"— This field only returns for the following operations: * change_password * sign_out_from_all_devices -
operatorstring, format:email— The email address of the user that updated the user. -
operator_idstring— The user ID of the user that updated the user. -
time_stampinteger, format:int64— The user's update timestamp, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"operation": "change_password",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1,
"phone_number": "",
"company": "",
"pmi": 1,
"use_pmi": true,
"timezone": "",
"pic_url": "",
"vanity_name": "",
"host_key": "",
"role": "",
"dept": "",
"language": "",
"settings": {
"feature": {
"large_meeting_capacity": 1,
"webinar": true,
"webinar_capacity": 1
},
"meeting_capacity": 1,
"large_meeting": ""
},
"custom_attributes": [
{
"key": "",
"name": "",
"value": 1
}
],
"primary_group_id": ""
},
"time_stamp": 1,
"old_object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1,
"phone_number": "",
"company": "",
"pmi": 1,
"use_pmi": true,
"timezone": "",
"pic_url": "",
"vanity_name": "",
"host_key": "",
"role": "",
"dept": "",
"language": "",
"settings": {
"feature": {
"large_meeting_capacity": 1,
"webinar": true,
"webinar_capacity": 1
},
"meeting_capacity": 1,
"large_meeting": ""
},
"custom_attributes": [
{
"key": "",
"name": "",
"value": 1
}
],
"primary_group_id": ""
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user that updated the user. -
object(required)object— Information about the updated user.-
id(required)string— The user's ID. -
companystring— The user's company. -
custom_attributesarray— Information about the user's custom attributes. This field only returns if users are assigned custom attributes.Items:
-
key(required)string— The custom attribute's unique ID. -
name(required)string— The custom attribute's name. -
value(required)integer— The custom attribute's value.
-
-
deptstring— The user's department. -
display_namestring— The user's display name. -
emailstring, format:email— The user's email address. -
first_namestring— The user's first name. -
host_keystring— The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063). -
languagestring— The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475). -
last_namestring— The user's last name. -
phone_countrystring— **Note:** This field is **deprecated**. Use the phone_numbers field. The user's phone number country. -
phone_numberstring— The user's phone number. -
pic_urlstring— The user's profile picture URL. -
pmiinteger, format:int64— The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271). -
primary_group_idstring— The user's primary group id, the field returns values if a user's primary group is changed. -
rolestring— The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983). -
settingsobject— The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting).-
featureobject— The user's updated profile features.-
large_meeting_capacityinteger— The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis. -
webinarboolean— Whether the Webinar plan is enabled for the user. -
webinar_capacityinteger— The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis.
-
-
large_meetingstring— Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user. -
meeting_capacityinteger— The user's meeting capacity.
-
-
timezonestring— The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api). -
typeinteger, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
use_pmiboolean— Whether a PMI will be used instead of an auto-generated meeting ID. -
vanity_namestring— The user's personal meeting room name.
-
-
old_objectobject— Information about the user's previous value.-
id(required)string— The user's ID. -
companystring— The user's company. -
custom_attributesarray— Information about the user's custom attributes. This field only returns if users are assigned custom attributes.Items:
-
key(required)string— The custom attribute's unique ID. -
name(required)string— The custom attribute's name. -
value(required)integer— The custom attribute's value.
-
-
deptstring— The user's department. -
display_namestring— The user's display name. -
emailstring, format:email— The user's email address. -
first_namestring— The user's first name. -
host_keystring— The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063). -
languagestring— The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475). -
last_namestring— The user's last name. -
phone_countrystring— **Note:** This field is **deprecated**. Use the phone_numbers field. The user's phone number country. -
phone_numberstring— The user's phone number. -
pic_urlstring— The user's profile picture URL. -
pmiinteger, format:int64— The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271). -
primary_group_idstring— The user's primary group id, the field returns values if a user's primary group is changed. -
rolestring— The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983). -
settingsobject— The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting).-
featureobject— The user's updated profile features.-
large_meeting_capacityinteger— The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis. -
webinarboolean— Whether the Webinar plan is enabled for the user. -
webinar_capacityinteger— The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis.
-
-
large_meetingstring— Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user. -
meeting_capacityinteger— The user's meeting capacity.
-
-
timezonestring— The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api). -
typeinteger, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
use_pmiboolean— Whether a PMI will be used instead of an auto-generated meeting ID. -
vanity_namestring— The user's personal meeting room name.
-
-
operationstring, possible values:"change_password", "sign_out_from_all_devices"— This field only returns for the following operations: * change_password * sign_out_from_all_devices -
operatorstring, format:email— The email address of the user that updated the user. -
operator_idstring— The user ID of the user that updated the user. -
time_stampinteger, format:int64— The user's update timestamp, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"operation": "change_password",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1,
"phone_number": "",
"company": "",
"pmi": 1,
"use_pmi": true,
"timezone": "",
"pic_url": "",
"vanity_name": "",
"host_key": "",
"role": "",
"dept": "",
"language": "",
"settings": {
"feature": {
"large_meeting_capacity": 1,
"webinar": true,
"webinar_capacity": 1
},
"meeting_capacity": 1,
"large_meeting": ""
},
"custom_attributes": [
{
"key": "",
"name": "",
"value": 1
}
],
"primary_group_id": ""
},
"time_stamp": 1,
"old_object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1,
"phone_number": "",
"company": "",
"pmi": 1,
"use_pmi": true,
"timezone": "",
"pic_url": "",
"vanity_name": "",
"host_key": "",
"role": "",
"dept": "",
"language": "",
"settings": {
"feature": {
"large_meeting_capacity": 1,
"webinar": true,
"webinar_capacity": 1
},
"meeting_capacity": 1,
"large_meeting": ""
},
"custom_attributes": [
{
"key": "",
"name": "",
"value": 1
}
],
"primary_group_id": ""
}
}
}
POST group.deleted
- Method:
POST - Path:
group.deleted - Tags: group
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
operator(required)string, format:email— The email address of the user that deleted the group. -
operator_id(required)string— The user ID of the user that deleted the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The group's account ID. -
object(required)object-
id(required)string— The group ID. -
name(required)string— The group name.
-
-
operator(required)string, format:email— The email address of the user that deleted the group. -
operator_id(required)string— The user ID of the user that deleted the group. -
time_stampinteger, format:int64— A timestamp that indicates when the group was deleted, in milliseconds.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"time_stamp": 1,
"object": {
"id": "",
"name": ""
}
}
}
POST user.created
- Method:
POST - Path:
user.created - Tags: user
Request Body
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user who created the user. -
creation_type(required)string, possible values:"create", "ssoCreate", "autoCreate", "custCreate"— The method used to create the new user: * create * ssoCreate * autoCreate * custCreate -
object(required)object— Information about the created user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
display_namestring— The user's display name. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
operator(required)string, format:email— The email address of the user who created the new user. -
operator_id(required)string— The user ID of the user that created the new user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"creation_type": "create",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1
}
}
}
Responses
Status: 200
Content-Type: application/json
-
event(required)string— The name of the event. -
event_ts(required)integer, format:int64— A timestamp at which the event occurred. -
payload(required)object-
account_id(required)string— The account ID of the user who created the user. -
creation_type(required)string, possible values:"create", "ssoCreate", "autoCreate", "custCreate"— The method used to create the new user: * create * ssoCreate * autoCreate * custCreate -
object(required)object— Information about the created user.-
email(required)string, format:email— The user's email address. -
id(required)string— The user's ID. -
type(required)integer, possible values:1, 2— The type of user: * 1 — Basic. * 2 — Licensed. -
display_namestring— The user's display name. -
first_namestring— The user's first name. -
last_namestring— The user's last name.
-
-
operator(required)string, format:email— The email address of the user who created the new user. -
operator_id(required)string— The user ID of the user that created the new user.
-
Example:
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"creation_type": "create",
"object": {
"id": "",
"first_name": "",
"last_name": "",
"display_name": "",
"email": "",
"type": 1
}
}
}