{"openapi":"3.0.0","info":{"title":"Users Webhooks","description":"The User webhooks allow developers to receive events related to users and groups.","version":"1.0.0"},"paths":{"group.admin_added":{"post":{"tags":["Groups"],"summary":"group.admin_added","description":"\nThe **Group admin added** event is triggered every time one of your app users or account users add a group admin. Group admins can be added in the [Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings#h_6bdb29aa-2bed-4e7c-abfe-1b076354419f) or via the [**Add group admins**](/api-reference/zoom-api/methods#operation/groupAdminsCreate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group admin added** subscription enabled under the **Group** event.\n\n","operationId":"Group.admin_addedWebhook","requestBody":{"description":"Webhook payload for the `group.admin_added` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.admin_addedEvent"},"examples":{"default":{"summary":"Example group.admin_added event","value":{"event":"group.admin_added","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","admins":[{"id":"qB1V0HKFQrGODVhJmqUEQw","email":"jchill@example.com"}]},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.lock_settings_updated":{"post":{"tags":["Groups"],"summary":"group.lock_settings_updated","description":"\nZoom triggers this event when an account owner or user updates a [group's lock settings](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings).  \n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The \"**Group's lock settings updated**\" subscription enabled under the **Group** event.","operationId":"Group.lock_settings_updatedWebhook","requestBody":{"description":"Webhook payload for the `group.lock_settings_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.lock_settings_updatedEvent"},"examples":{"default":{"summary":"Example group.lock_settings_updated event","value":{"event":"group.lock_settings_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator_id":"g4ebA91YR7GPQw6QKvxwVw","operator":"adminr@example.com","object":{"id":"49D7a0xPQvGQ2DCMZgSe7w","settings":{"recording":{"cloud_recording":false},"ai":{"whiteboard_content_generation":true,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true,"delete_ai_conversation":true,"delete_ai_conversation_time":true},"ai_panel_in_workplace":{"enabled":true,"delete_ai_conversation":true,"delete_ai_conversation_time":true},"enable_ai_on_web":true,"microsoft_365":{"enable":true},"google":{"enable":true},"web_content":true,"local_file_uploads":true,"organization_custom_dictionaries":true,"third_party_app_tasks":true,"webinar_summary_follow_up_email":false,"webinar_summary_ocr":false,"zoom_events_session_summary":{"enable":false,"auto_start":false},"hub_ai_question_and_file_creation":true,"canvas_ai_content_generation":true,"canvas_ai_sentence_completion":true,"canvas_ai_post_meeting_writing_tasks":true,"paper_ai_content_generation":true,"sheets_ai_content_generation":true,"sheets_ai_formula":true,"sheets_ai_function":true,"sheets_ai_resources":true,"slides_ai_content_generation":true,"my_notes_meeting_transcription":true,"my_notes_ai_content_generation":true,"chat_summary":true,"chat_compose":true,"webinar_questions":{"enable":false,"auto_enable":false,"who_can_ask_questions":false},"webinar_summary":{"enable":false,"auto_enable":false,"who_will_receive_summary":false},"include_webinar_summary_follow_up_email":{"enable":false}}}},"time_stamp":1626230691572,"old_object":{"id":"49D7a0xPQvGQ2DCMZgSe7w","settings":{"recording":{"cloud_recording":true},"ai":{"whiteboard_content_generation":false,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true,"delete_ai_conversation":true,"delete_ai_conversation_time":true},"ai_panel_in_workplace":{"enabled":true,"delete_ai_conversation":true,"delete_ai_conversation_time":true},"enable_ai_on_web":true,"microsoft_365":{"enable":false},"google":{"enable":false},"web_content":false,"local_file_uploads":false,"organization_custom_dictionaries":false,"third_party_app_tasks":false,"webinar_summary_follow_up_email":false,"webinar_summary_ocr":false,"zoom_events_session_summary":{"enable":false,"auto_start":false},"hub_ai_question_and_file_creation":true,"canvas_ai_content_generation":true,"canvas_ai_sentence_completion":true,"canvas_ai_post_meeting_writing_tasks":true,"paper_ai_content_generation":true,"sheets_ai_content_generation":true,"sheets_ai_formula":true,"sheets_ai_function":true,"sheets_ai_resources":true,"slides_ai_content_generation":true,"my_notes_meeting_transcription":true,"my_notes_ai_content_generation":true,"chat_summary":true,"chat_compose":true,"webinar_questions":{"enable":false,"auto_enable":false,"who_can_ask_questions":false},"webinar_summary":{"enable":false,"auto_enable":false,"who_will_receive_summary":false},"include_webinar_summary_follow_up_email":{"enable":false}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.admin_deleted":{"post":{"tags":["Groups"],"summary":"group.admin_deleted","description":"\nThe **Group admin deleted** event is triggered every time one of your app users or account users delete a group admin. Group admins can be deleted in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings) or via the [**Delete group admins**](/api-reference/zoom-api/methods#operation/groupAdminsDelete) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group admin deleted** subscription enabled under the **Group** event.\n\n","operationId":"Group.admin_deletedWebhook","requestBody":{"description":"Webhook payload for the `group.admin_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.admin_deletedEvent"},"examples":{"default":{"summary":"Example group.admin_deleted event","value":{"event":"group.admin_deleted","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","admins":[{"id":"qB1V0HKFQrGODVhJmqUEQw","email":"jchill@example.com"}]},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.member_deleted":{"post":{"tags":["Groups"],"summary":"group.member_deleted","description":"\nThe **Group member deleted** event is triggered every time one of your app users or account users delete members in a group. Group members can be removed in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings#h_a96c2cc7-224b-4a02-9c35-c7b7fea8508a) or via the [**Delete group members**](/api-reference/zoom-api/methods#operation/groupMembersDelete) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group member deleted** subscription enabled under the **Group** event.\n\n","operationId":"Group.member_deletedWebhook","requestBody":{"description":"Webhook payload for the `group.member_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.member_deletedEvent"},"examples":{"default":{"summary":"Example group.member_deleted event","value":{"event":"group.members_deleted","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","members":[{"id":"qB1V0HKFQrGODVhJmqUEQw","email":"jchill@example.com"}]},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.deleted":{"post":{"tags":["Users"],"summary":"user.deleted","description":"\nThe **User has been deleted** event is triggered when an admin or account owner deletes a user from a Zoom account.\n\nDeleting users permanently removes them and their data from the Zoom system.\nTo delete a user, use the [**Delete a user**](/api-reference/zoom-api/methods#operation/userDelete) with `delete` as the value for `action` query parameter or [delete the user from the Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_7402c643-23d1-48f7-8cf3-efefdb678a88) itself.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscription** must be enabled for your [Marketplace App](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **User has been deleted** subscription must be enabled under the **User** event.\n\n","operationId":"User.deletedWebhook","requestBody":{"description":"Webhook payload for the `user.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.deletedEvent"},"examples":{"default":{"summary":"Example user.deleted event","value":{"event":"user.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","type":1}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.deactivated":{"post":{"tags":["Users"],"summary":"user.deactivated","description":"\nThe **User has been deactivated** event is triggered every time one of your app users or account users gets deactivated.\n\nAdmins and account owners can deactivate users in a Zoom account as well as activate the previously deactivated users. Deactivated users cannot log into their Zoom account and they do not have access to utilize any of the Zoom features. Users can be deactivated either from the [Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) or by using the [**Update user status**](/api-reference/zoom-api/methods#operation/userStatus) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has been deactivated** subscription must be enabled under the **User** event.\n\n","operationId":"User.deactivatedWebhook","requestBody":{"description":"Webhook payload for the `user.deactivated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.deactivatedEvent"},"examples":{"default":{"summary":"Example user.deactivated event","value":{"event":"user.deactivated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","type":3}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.settings_updated":{"post":{"tags":["Users"],"summary":"user.settings_updated","description":"\nZoom triggers this event when a user updates the settings of your app users or account.\n\nZoom users can update the settings on their profile manually from the [settings page on the Zoom Web Portal](https://zoom.us/profile/setting). Alternatively, the settings can also be updated by calling the [**Update user settings**](/api-reference/zoom-api/methods#operation/userSettingsUpdate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **User's settings have been updated** subscription must be enabled under the **User** event.","operationId":"User.settings_updatedWebhook","requestBody":{"description":"Webhook payload for the `user.settings_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.settings_updatedEvent"},"examples":{"default":{"summary":"Example user.settings_updated event","value":{"event":"user.settings_updated","event_ts":1626230691572,"payload":{"account_id":"McvRaRa6RN7gbIdYCSw-Dw","time_stamp":1626230691572,"operator":"admin@example.com","operator_id":"eUblMKLnTMKX0pVvNAlA0Q","object":{"id":"eUblMKLnTMKX0pVvNAlA0Q","settings":{"in_meeting":{"custom_live_streaming_service":true},"ai":{"whiteboard_content_generation":true,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true},"ai_panel_in_workplace":{"enabled":true},"enable_ai_on_web":true,"webinar_summary_follow_up_email":true,"webinar_summary_ocr":true,"zoom_events_session_summary":{"enable":true,"auto_start":true},"hub_ai_question_and_file_creation":true,"canvas_ai_content_generation":true,"canvas_ai_sentence_completion":true,"canvas_ai_post_meeting_writing_tasks":true,"paper_ai_content_generation":true,"sheets_ai_content_generation":true,"sheets_ai_formula":true,"sheets_ai_function":true,"sheets_ai_resources":true,"slides_ai_content_generation":true,"my_notes_meeting_transcription":true,"my_notes_ai_content_generation":{"enable":true},"chat_summary":{"enable":false,"show_in_zoom_chat":true},"chat_compose":{"enable":false,"show_in_zoom_chat":true},"webinar_questions":{"enable":true,"auto_enable":false,"who_can_ask_questions":"panelist_org"},"webinar_summary":{"enable":true,"auto_enable":false,"email_notification":true,"whether_include_full_text_in_email":"include_full_text_in_email","restrict_share_to_outside_of_organization":true,"restrict_summary_share":"external_users","who_will_receive_summary":"host_and_panelist_in_organization"},"include_webinar_summary_follow_up_email":{"enable":true,"attendee_follow_up_email":true,"absentee_follow_up_email":false}}}},"old_object":{"id":"eUulMKLnTMKX0pVvMAlB0Q","settings":{"in_meeting":{"custom_live_streaming_service":false},"ai":{"whiteboard_content_generation":false,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true},"ai_panel_in_workplace":{"enabled":true},"enable_ai_on_web":true,"webinar_summary_follow_up_email":true,"webinar_summary_ocr":true,"zoom_events_session_summary":{"enable":true,"auto_start":true},"hub_ai_question_and_file_creation":false,"canvas_ai_content_generation":false,"canvas_ai_sentence_completion":false,"canvas_ai_post_meeting_writing_tasks":false,"paper_ai_content_generation":false,"sheets_ai_content_generation":false,"sheets_ai_formula":false,"sheets_ai_function":false,"sheets_ai_resources":false,"slides_ai_content_generation":false,"my_notes_meeting_transcription":false,"my_notes_ai_content_generation":{"enable":false},"chat_summary":{"enable":false,"show_in_zoom_chat":true},"chat_compose":{"enable":false,"show_in_zoom_chat":true},"webinar_questions":{"enable":true,"auto_enable":false,"who_can_ask_questions":"panelist_org"},"webinar_summary":{"enable":true,"auto_enable":false,"email_notification":true,"whether_include_full_text_in_email":"include_full_text_in_email","restrict_share_to_outside_of_organization":true,"restrict_summary_share":"external_users","who_will_receive_summary":"host_and_panelist_in_organization"},"include_webinar_summary_follow_up_email":{"enable":true,"attendee_follow_up_email":true,"absentee_follow_up_email":false}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.invitation_accepted":{"post":{"tags":["Users"],"summary":"user.invitation_accepted","description":"\nThe **User has accepted the account invitation** event is triggered every time a user accepts the invitation to join a Zoom account.\n\nAdmins and account owners can add new users as well as existing users with free Zoom accounts to an account. The user can be added either from the [Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/201363183-User-Management#h_335dcf54-d106-4c8d-8533-68e2fc3d20a6) or by using the [**Create users**](/api-reference/zoom-api/methods#operation/userCreate) API. Once a user is added, an invitation email is sent to the user.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has accepted the account invitation** subscription must be enabled under the **User** event.\n\n","operationId":"User.invitation_acceptedWebhook","requestBody":{"description":"Webhook payload for the `user.invitation_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.invitation_acceptedEvent"},"examples":{"default":{"summary":"Example user.invitation_accepted event","value":{"event":"user.invitation_accepted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","type":3}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.created":{"post":{"tags":["Groups"],"summary":"group.created","description":"\nThe **Group created** event is triggered every time one of your app users or account users creates a group. Groups can be added in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings#h_1e8d02d6-3ab6-4084-81e1-27e47864f262) or via the [**Create a group**](/api-reference/zoom-api/methods#operation/groupCreate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group created** subscription enabled under the **Group** event.\n\n","operationId":"Group.createdWebhook","requestBody":{"description":"Webhook payload for the `group.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.createdEvent"},"examples":{"default":{"summary":"Example group.created event","value":{"event":"group.created","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","name":"example-group"},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.settings_updated":{"post":{"tags":["Groups"],"summary":"group.settings_updated","description":"\nZoom triggers this event when account owners or users update a group's [settings](https://zoom.us/account/group/{groupId}/setting).  \n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** are enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The \"**Group's setting updated**\" subscription enabled under the **Group** event.","operationId":"Group.settings_updatedWebhook","requestBody":{"description":"Webhook payload for the `group.settings_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.settings_updatedEvent"},"examples":{"default":{"summary":"Example group.settings_updated event","value":{"event":"group.settings_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator_id":"g4ebA91YR7GPQw6QKvxwVw","operator":"admin@example.com","object":{"id":"49D7a0xPQvGQ2DCMZgSe7w","settings":{"recording":{"auto_recording":true},"ai":{"whiteboard_content_generation":true,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true,"delete_ai_conversation":true,"delete_ai_conversation_time":30},"ai_panel_in_workplace":{"enabled":true,"delete_ai_conversation":true,"delete_ai_conversation_time":30},"enable_ai_on_web":true,"enable_email_compose_with_ai":true,"microsoft_365":{"enable":true,"calendar_events":true,"emails":true,"documents":true},"google":{"enable":true,"calendar_events":true,"emails":true,"documents":true},"web_content":true,"local_file_uploads":true,"organization_custom_dictionaries":true,"third_party_app_tasks":true,"webinar_summary_follow_up_email":true,"webinar_summary_ocr":true,"zoom_events_session_summary":{"enable":true,"auto_start":true},"hub_ai_question_and_file_creation":true,"canvas_ai_content_generation":true,"canvas_ai_sentence_completion":true,"canvas_ai_post_meeting_writing_tasks":true,"paper_ai_content_generation":true,"sheets_ai_content_generation":true,"sheets_ai_formula":true,"sheets_ai_function":true,"sheets_ai_resources":true,"slides_ai_content_generation":true,"my_notes_meeting_transcription":true,"my_notes_ai_content_generation":{"enable":true,"auto_generate_summary":true,"auto_send_summary_email":true},"chat_summary":{"enable":true},"chat_compose":{"enable":true},"webinar_questions":{"enable":true,"auto_enable":false,"who_can_ask_questions":"panelist_org"},"webinar_summary":{"enable":true,"auto_enable":false,"email_notification":true,"whether_include_full_text_in_email":"include_full_text_in_email","restrict_share_to_outside_of_organization":true,"restrict_summary_share":"external_users","who_will_receive_summary":"host_and_panelist_in_organization"},"include_webinar_summary_follow_up_email":{"enable":true,"attendee_follow_up_email":true,"absentee_follow_up_email":false}}}},"time_stamp":1626230691572,"old_object":{"id":"49D7a0xPQvGQ2DCMZgSe7w","settings":{"recording":{"auto_recording":false},"ai":{"whiteboard_content_generation":false,"show_conversational_ai_companion":{"enabled":true,"enable_zoom_mate":true,"delete_ai_conversation":true,"delete_ai_conversation_time":30},"ai_panel_in_workplace":{"enabled":true,"delete_ai_conversation":true,"delete_ai_conversation_time":30},"enable_ai_on_web":true,"enable_email_compose_with_ai":true,"microsoft_365":{"enable":false,"calendar_events":false,"emails":false,"documents":false},"google":{"enable":false,"calendar_events":false,"emails":false,"documents":false},"web_content":false,"local_file_uploads":false,"organization_custom_dictionaries":false,"third_party_app_tasks":false,"webinar_summary_follow_up_email":true,"webinar_summary_ocr":true,"zoom_events_session_summary":{"enable":true,"auto_start":true},"chat_summary":{"enable":true},"chat_compose":{"enable":true},"hub_ai_question_and_file_creation":false,"canvas_ai_content_generation":false,"canvas_ai_sentence_completion":false,"canvas_ai_post_meeting_writing_tasks":false,"paper_ai_content_generation":false,"sheets_ai_content_generation":false,"sheets_ai_formula":false,"sheets_ai_function":false,"sheets_ai_resources":false,"slides_ai_content_generation":false,"my_notes_meeting_transcription":false,"my_notes_ai_content_generation":{"enable":false,"auto_generate_summary":false,"auto_send_summary_email":false},"webinar_questions":{"enable":true,"auto_enable":false,"who_can_ask_questions":"panelist_org"},"webinar_summary":{"enable":true,"auto_enable":false,"email_notification":true,"whether_include_full_text_in_email":"include_full_text_in_email","restrict_share_to_outside_of_organization":true,"restrict_summary_share":"external_users","who_will_receive_summary":"host_and_panelist_in_organization"},"include_webinar_summary_follow_up_email":{"enable":true,"attendee_follow_up_email":true,"absentee_follow_up_email":false}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.disassociated":{"post":{"tags":["Users"],"summary":"user.disassociated","description":"\nThe **User has been disassociated** event is triggered every time one of your app users or account users is unlinked from an account.\n\nUnlinking a user from an account allows them to maintain their own Zoom account with existing settings, meetings, webinars, and Cloud recordings. Users can be disassociated from a Zoom account [via the Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_98a81098-0ca3-45ae-8d00-aab235cc781d) or via the [**Delete a user**](/api-reference/zoom-api/methods#operation/userDelete) API with `disassociate` as the value of `action` query parameter.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **User has been disassociated** subscription must be enabled under the **User** event.\n\n","operationId":"User.disassociatedWebhook","requestBody":{"description":"Webhook payload for the `user.disassociated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.disassociatedEvent"},"examples":{"default":{"summary":"Example user.disassociated event","value":{"event":"user.disassociated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","type":3}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.updated":{"post":{"tags":["Groups"],"summary":"group.updated","description":"\nThe **Group updated** event is triggered every time one of your app users or account users update a group. Groups can be updated in the [Zoom web portal](https://support.zoomus/hc/en-us/articles/204519819-Managing-user-groups-and-settings) or via the [**Update a group**](/api-reference/zoom-api/methods#operation/groupUpdate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group updated** subscription enabled under the **Group** event.\n\n","operationId":"Group.updatedWebhook","requestBody":{"description":"Webhook payload for the `group.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.updatedEvent"},"examples":{"default":{"summary":"Example group.updated event","value":{"event":"group.updated","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","name":"example-group-new"},"old_object":{"id":"abcD3ojfdbjfg","name":"example-group-old"},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.presence_status_updated":{"post":{"tags":["Users"],"summary":"user.presence_status_updated","description":"\nThe **User's presence status has been updated** event triggers whenever a user's presence status changes in the Zoom Client app.\n\n## Presence Status Options\n\nUsers signed in to Zoom can set their [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488) in the [Zoom Client apps](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407) to one of the following:\n\n- **Available** — The user is available. This is the default status set when the user signed in.\n- **Away** — The user is away. The user manually sets this status.\n- **Do_Not_Disturb** — The user does not want to be disturbed. The user sets this status to avoid interruptions.\n\nZoom also automatically updates the presence status based on user activity:\n\n- **In_Meeting** — The user joins a Zoom meeting.\n- **Presenting** — The user shares their screen during a meeting.\n- **On_Phone_Call** — The user makes or receives a Zoom Phone call.\n- **In_Calendar_Event** — The user joins a calendar event (from a synced calendar) but not a Zoom meeting.\n- **Mobile_signed_in** — The user's desktop device goes offline while their mobile device remains signed in.\n\n## Prerequisites\n\nTo receive this event, configure your [Marketplace app](https://marketplace.zoom.us/user/build) as follows:\n\n- Enable **Event Subscriptions**\n- Provide a valid **Event Notification Endpoint URL**\n- Enable the **User's presence status has been updated** subscription under the **User Activity** event","operationId":"User.presence_status_updatedWebhook","requestBody":{"description":"Webhook payload for the `user.presence_status_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.presence_status_updatedEvent"},"examples":{"default":{"summary":"Example user.presence_status_updated event","value":{"event":"user.presence_status_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"date_time":"2019-11-26T20:13:57Z","email":"jchill@example.com","id":"abcD3ojfdbjfg","presence_status":"Away","app":{"type":"mobile","presence_status":"Offline"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.activated":{"post":{"tags":["Users"],"summary":"user.activated","description":"\nThe **User has been activated** event is triggered every time one of your app users or account users activates a deactivated user.\n\nAdmins and account owners can deactivate users in a Zoom account as well as activate the previously deactivated users. To activate a user who was previously deactivated, call the [**Update user status**](/api-reference/zoom-api/methods#operation/userStatus) API or [activate the user from the Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0). Any licenses or plans that the user had prior to deactivation will have to be reassigned after activation.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has been activated** subscription must be enabled under the **User** event.\n\n","operationId":"User.activatedWebhook","requestBody":{"description":"Webhook payload for the `user.activated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.activatedEvent"},"examples":{"default":{"summary":"Example user.activated event","value":{"event":"user.activated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","first_name":"Dana","last_name":"Lee","email":"jchill@example.com","type":3}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.signed_in":{"post":{"tags":["Users"],"summary":"user.signed_in","description":"\nThe **User has signed in** event is triggered every time one of your app users or account users signs in to Zoom.\n\nUsers that are registered with Zoom can sign in and sign out of their Zoom accounts at any time using their email and password via [Zoom Web Portal](https://zoom.us/signin) as well as any of the [Zoom Client apps](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407). For users that have SSO enabled, they can also [log in with their SSO](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061708). The exceptions to this are [deactivated users](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997), and users created using the `custCreate` option via the [**Create users**](/docs/api/users/#tag/users/post/users) API. These users do not have the ability to sign in with Zoom.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has signed in** subscription must be enabled under the **User Activity** event.","operationId":"User.signed_inWebhook","requestBody":{"description":"Webhook payload for the `user.signed_in` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.signed_inEvent"},"examples":{"default":{"summary":"Example user.signed_in event","value":{"event":"user.signed_in","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","client_type":"android","date_time":"2021-07-26T20:13:57Z","email":"jchill@example.com","version":"5.7.4.1585","login_type":100}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.signed_out":{"post":{"tags":["Users"],"summary":"user.signed_out","description":"\nThe **User has signed out** event is triggered every time one of your app users or account users signs out of Zoom.\n\nUsers that are signed in can sign out of their Zoom accounts using the [Zoom Web Portal](https://zoom.us/signin) as well as any of the [Zoom Client](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407) apps.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has signed out** subscription must be enabled under the **User Activity** event.","operationId":"User.signed_outWebhook","requestBody":{"description":"Webhook payload for the `user.signed_out` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.signed_outEvent"},"examples":{"default":{"summary":"Example user.signed_out event","value":{"event":"user.signed_out","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","client_type":"android","date_time":"2021-07-26T20:13:57Z","email":"jchill@example.com","version":"5.7.4.1585","login_type":100}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.personal_notes_updated":{"post":{"tags":["Users"],"summary":"user.personal_notes_updated","description":"\nThe **User's personal notes have been updated** event is triggered every time one of your app users or account users updates personal notes on the Zoom Client app.\n\nUsers that are signed in to Zoom can set their presence status in the [Zoom Client apps](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407) can specify a personal note that appears at the top of the chat profile to anyone who can see the profile. The note can be changed as often as needed and is commonly used to provide a meaningful note, a job title, or to include detailed information about the user's presence status.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User's personal notes have been updated** subscription must be enabled under the **User Activity** event.","operationId":"User.personal_notes_updatedWebhook","requestBody":{"description":"Webhook payload for the `user.personal_notes_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.personal_notes_updatedEvent"},"examples":{"default":{"summary":"Example user.personal_notes_updated event","value":{"event":"user.personal_notes_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","email":"jchill@example.com","date_time":"","personal_notes":"New note."},"old_object":{"personal_notes":"Old note."}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.member_added":{"post":{"tags":["Groups"],"summary":"group.member_added","description":"\nThe **Group member added** event is triggered every time one of your app users or account users add members to a group. Group members can be added in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/204519819-Managing-user-groups-and-settings#h_a96c2cc7-224b-4a02-9c35-c7b7fea8508a) or via the [**Add group members**](/api-reference/zoom-api/methods#operation/groupMembersCreate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group member added** subscription enabled under the **Group** event.\n\n","operationId":"Group.member_addedWebhook","requestBody":{"description":"Webhook payload for the `group.member_added` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.member_addedEvent"},"examples":{"default":{"summary":"Example group.member_added event","value":{"event":"group.member_added","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","members":[{"id":"qB1V0HKFQrGODVhJmqUEQw","email":"jchill@example.com"}]},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.updated":{"post":{"tags":["Users"],"summary":"user.updated","description":"\nThe **User's profile info has been updated** event is triggered every time the profile of one of your app users or account users is updated.\n\nUsers, account admins, and account owners can update information on the user profile information. Profile updates can be made either by accessing the [profile on the Zoom client](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060639) and making edits or by calling the [**Update a user**](/docs/api/users/#tag/users/patch/users/{userId}) API.\n\n## Prerequisites\n\n* **Event Subscription** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**\n\t* The **User's profile info has been updated** subscription must be enabled under the **User** event.","operationId":"User.updatedWebhook","requestBody":{"description":"Webhook payload for the `user.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.updatedEvent"},"examples":{"default":{"summary":"Example user.updated event","value":{"event":"user.updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"eUblMKLnTMKX0pVvNAlA0Q","time_stamp":1626230691572,"old_object":{"email":"xxxxxx.old@zoom.us","id":"abcD3ojfdbjfg"},"object":{"email":"xxxxxx@zoom.us","id":"eUblMKLnTMKX0pVvNAlA0Q"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"group.deleted":{"post":{"tags":["Groups"],"summary":"group.deleted","description":"\nThe **Group deleted** event is triggered every time one of your app users or account users delete a group. Groups can be deleted in the [Zoom web portal](https://support.zoomus/hc/en-us/articles/204519819-Managing-user-groups-and-settings) or via the [**Delete a group**](/api-reference/zoom-api/methods#operation/groupDelete) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Group deleted** subscription enabled under the **Group** event.\n\n","operationId":"Group.deletedWebhook","requestBody":{"description":"Webhook payload for the `group.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group.deletedEvent"},"examples":{"default":{"summary":"Example group.deleted event","value":{"event":"group.deleted","event_ts":1626230691572,"payload":{"account_id":"x1yCzABCDEfg23HiJKl4mN","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":"abcD3ojfdbjfg","name":"example-group"},"time_stamp":1626230691572}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.created":{"post":{"tags":["Users"],"summary":"user.created","description":"\nThe **User has been created** event is triggered every time one of your app users or account users adds another user to the account.\n\nAdmins and account owners can add new users to an account. The user can be added either from the [Zoom Web Portal](https://support.zoom.us/hc/en-us/articles/201363183-User-Management#h_335dcf54-d106-4c8d-8533-68e2fc3d20a6) or by using the [**Create users**](/api-reference/zoom-api/methods#operation/userCreate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **User has been created** subscription must be enabled under the **User** event.\n\n","operationId":"User.createdWebhook","requestBody":{"description":"Webhook payload for the `user.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.createdEvent"},"examples":{"default":{"summary":"Example user.created event","value":{"event":"user.created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","creation_type":"create","object":{"id":"abcD3ojfdbjfg","first_name":"Jill","last_name":"Chill","display_name":"Jill Chill","email":"jchill@example.com","type":3}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Group.admin_addedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that added the admin to the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that added the admin to the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's admin were added, in milliseconds.","format":"int64"},"object":{"required":["admins","id"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"admins":{"type":"array","description":"Information about the group administrators.","items":{"type":"object","properties":{"id":{"type":"string","description":"The administrator's user ID."},"email":{"type":"string","description":"The admin's email address.","format":"email"}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"Group.lock_settings_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the group's settings."},"operator":{"type":"string","description":"The email address of the user that updated the group's settings.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the group's settings."},"object":{"required":["id","settings"],"type":"object","properties":{"id":{"type":"string","description":"The updated group's ID."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"boolean","description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call) setting enabled."},"toll_call":{"type":"boolean","description":"Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"call_me_and_invite_by_phone":{"type":"boolean","description":"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.","example":true},"personal_audio_conference":{"type":"boolean","description":"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.","example":true},"participant_phone_masking":{"type":"boolean","description":"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.","example":true}},"description":"Group Audio Conference Settings"},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Whether alternative hosts receive an email when they are added or removed to a meeting."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether meeting participants and hosts receive a notification when the meeting is canceled."},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether the host is notified when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether the host is notified when participants join the meeting before them."},"schedule_for_reminder":{"type":"boolean","description":"Whether the host is notified if a meeting is scheduled, rescheduled, or canceled."}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","description":"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_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether livestreaming is allowed."},"allow_show_zoom_windows":{"type":"boolean","description":"Whether Zoom windows display screen share."},"annotation":{"type":"boolean","description":"Whether meeting participants can use annotation tools to add information to shared screens."},"auto_answer":{"type":"boolean","description":"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_captions":{"type":"boolean","description":"Whether live transcription services are available to transcribe meetings."},"auto_saving_chat":{"type":"boolean","description":"Whether all in-meeting chats are automatically saved."},"breakout_room":{"type":"boolean","description":"Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms)."},"chat":{"type":"boolean","description":"Whether meeting participants can send chat messages that are visible to all participants."},"closed_caption":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"co_host":{"type":"boolean","description":"Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host."},"custom_data_center_regions":{"type":"boolean","description":"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_meetings":{"type":"boolean","description":"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_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"e2e_encryption":{"type":"boolean","description":"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_chime":{"type":"boolean","description":"Whether a chime plays when participants join or leave the meeting."},"far_end_camera_control":{"type":"boolean","description":"Whether other users are allowed to take control of the camera during a meeting."},"feedback":{"type":"boolean","description":"Whether users can provide feedback to Zoom at the end of the meeting."},"file_transfer":{"type":"boolean","description":"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_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel."},"group_hd":{"type":"boolean","description":"Whether a higher quality video for host and participants is enabled. This will require more bandwidth."},"language_interpretation":{"type":"boolean","description":"Whether hosts can assign participants as interpreters who can interpret one language into another in real-time."},"sign_language_interpretation":{"type":"boolean","description":"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."},"manual_captions":{"type":"boolean","description":"Whether hosts can type closed captions or assign a participant/third party device to add closed captions."},"meeting_reactions":{"type":"boolean","description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar."},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel."},"original_audio":{"type":"boolean","description":"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."},"polling":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether meeting participants can send private 1:1 chat message other meeting participants."},"remote_control":{"type":"boolean","description":"During screen sharing, whether the person who is presenting can let others control the shared content."},"remote_support":{"type":"boolean","description":"Whether the meeting host can provide 1:1 remote support to another participant."},"request_permission_to_unmute":{"type":"boolean","description":"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_caption":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"save_captions":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"screen_sharing":{"type":"boolean","description":"Whether hosts and participants can share their screen or content during meetings."},"sending_default_email_invites":{"type":"boolean","description":"Whether users can invite participants by email only by default."},"show_a_join_from_your_browser_link":{"type":"boolean","description":"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_link":{"type":"boolean","description":"Whether participants can join a meeting directly from their browser."},"show_meeting_control_toolbar":{"type":"boolean","description":"Whether to always display the meeting controls toolbar during a meeting."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"stereo_audio":{"type":"boolean","description":"Whether users can select stereo audio during a meeting."},"use_html_format_email":{"type":"boolean","description":"Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin."},"virtual_background":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"waiting_room":{"type":"boolean","description":"Whether participants cannot join a meeting until the host admits them from the waiting room."},"webinar_chat":{"type":"boolean","description":"Whether webinar participants can send chat messages."},"webinar_live_streaming":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"webinar_polling":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"webinar_survey":{"type":"boolean","description":"Whether the host can present surveys to attendees once a webinar has ended."},"whiteboard":{"type":"boolean","description":"Whether participants can share a whiteboard that includes annotation tools."}}},"other_options":{"type":"object","properties":{"blur_snapshot":{"type":"boolean","description":"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."}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Whether cloud recordings are accessible to account members."},"auto_delete_cmr":{"type":"boolean","description":"Whether Zoom automatically deletes recordings permanently after a specified number of days."},"auto_recording":{"type":"boolean","description":"Whether meetings are automatically recorded when they begin."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meetings and webinars in the cloud."},"cloud_recording_download":{"type":"boolean","description":"Whether anyone with a link to the cloud recording can download the file."},"host_delete_cloud_recording":{"type":"boolean","description":"Whether the host can delete cloud recordings. If `false`, only the admin can delete cloud recordings."},"ip_address_access_control":{"type":"boolean","description":"Whether cloud recording access is only available for a specific range of IP addresses."},"local_recording":{"type":"boolean","description":"Whether hosts and participants can record meetings to a local file."},"prevent_host_access_recording":{"type":"boolean","description":"Whether hosts can access and view their meetings' cloud recordings."},"recording_authentication":{"type":"boolean","description":"Whether only authenticated users can view cloud recordings."},"archive":{"type":"boolean","description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team."}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Whether participants can join only the audio portion of meetings."},"embed_password_in_join_link":{"type":"boolean","description":"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_password":{"type":"boolean","description":"Whether passwords are required to join before the host in personal meetings."},"host_video":{"type":"boolean","description":"Whether host video defaults to on when they join meetings."},"join_before_host":{"type":"boolean","description":"Whether participants can join meetings before the host."},"meeting_authentication":{"type":"boolean","description":"Whether only authenticated users can join meetings."},"mute_upon_entry":{"type":"boolean","description":"Whether all participants are automatically muted when they join meetings."},"participant_video":{"type":"boolean","description":"Whether participant video defaults to on when they join meetings."},"pstn_password_protected":{"type":"boolean","description":"Whether new passwords are generated and sent for newly-scheduled or edited meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled."},"require_password_for_pmi_meetings":{"type":"boolean","description":"Whether participants are required to enter a password for PMI meetings."},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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_reminder":{"type":"boolean","description":"Whether desktop notifications for upcoming meetings is enabled."}}},"telephony":{"type":"object","properties":{"telephony_regions":{"type":"boolean","description":"Whether telephony regions are enabled for meetings."},"third_party_audio":{"type":"boolean","description":"Whether users can join meetings using the existing third party audio configurations."}},"description":"Group Settings: Telephony."},"meeting_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"boolean","description":"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_security":{"type":"boolean","description":"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_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars."},"embed_password_in_join_link":{"type":"boolean","description":"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_type":{"type":"string","description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether end-to-end encryption is enabled for meetings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether only authenticated users can join meetings from the web client."},"phone_password":{"type":"boolean","description":"Whether passwords are required for participants joining by phone. \n\n 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_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"waiting_room":{"type":"boolean","description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n 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_password":{"type":"boolean","description":"Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar."}}},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether the screen_share_ocr setting is locked.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether the meeting_chat_messages setting is locked.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether the full_display_names_in_ai_assets setting is locked.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether the ai_generated_virtual_backgrounds setting is locked.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether the meeting_agenda setting is locked.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is locked.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether sharing generated Zoom Docs with meeting summary recipients is locked.","example":false}},"description":"Lock settings for meeting summary Docs."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are locked.","example":true}},"description":"Lock settings for phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is locked.","example":true}},"description":"Lock settings for meeting summary retention."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is locked.","example":true}},"description":"Lock settings for Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is locked.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording for joined third-party meetings is locked.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is locked.","example":true}},"description":"Lock settings for calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is locked.","example":true}},"description":"Lock settings for pre-meeting email notification."}},"description":"Lock settings for third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Smart Recording is locked.","example":true}},"description":"Lock settings for Smart Recording."},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether task creation and management with AI is locked.","example":true}},"description":"Lock settings for task creation and management with AI."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is locked.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate availability is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI conversation retention period is locked.","example":true}},"description":"Lock settings for the conversational AI companion."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion in the AI panel is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI panel conversation retention period is locked.","example":true}},"description":"Lock settings for the AI panel in Zoom Workplace."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is locked.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources are locked.","example":true}},"description":"Lock settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources are locked.","example":true}},"description":"Lock settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether Web content as an AI data source is locked.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether Local file uploads as an AI data source are locked.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether allowing AI to consume the organization's custom dictionaries is locked.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether allowing AI to perform tasks in third-party apps is locked.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Whether the participant_can_request_aic_in_meeting setting is locked.","example":false},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Whether the restrict_aic_when_external_user_join_meeting setting is locked.","example":false},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"Whether the restrict_aic_when_restrict_user_join setting is locked.","example":false},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether restrictions on joining AI-enabled meetings are locked.","example":false}},"description":"Lock settings for restrictions on joining AI-enabled meetings."},"meeting_questions":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether meeting questions are locked.","example":false},"auto_enable_locked":{"type":"boolean","description":"Whether automatic meeting questions are locked.","example":false},"who_can_ask_questions_locked":{"type":"boolean","description":"Whether the meeting questions participant scope is locked.","example":false}},"description":"Lock settings for meeting questions."},"meeting_summary":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether meeting summaries are locked.","example":false},"auto_enable_locked":{"type":"boolean","description":"Whether automatic meeting summaries are locked.","example":false},"who_will_receive_summary_locked":{"type":"boolean","description":"Whether the meeting summary recipient scope is locked.","example":false}},"description":"Lock settings for meeting summaries."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary templates are locked.","example":false}},"description":"Lock settings for meeting summary templates."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the default meeting summary language is locked.","example":false}},"description":"Lock settings for the default meeting summary language."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary IP access is locked.","example":false}},"description":"Lock settings for meeting summary IP access."},"remind_me_turn_on_aic":{"type":"boolean","description":"Whether the remind_me_turn_on_aic setting is locked.","example":false},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"Whether the remind_me_turn_on_catch_me_up setting is locked.","example":false},"meeting_summary_email_only_mode":{"type":"boolean","description":"Whether the meeting_summary_email_only_mode setting is locked.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"Whether the restrict_users_from_deleting_ai_companion_assets setting is locked.","example":false},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"Whether the restrict_users_from_editing_ai_companion_assets setting is locked.","example":false},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`. The Boolean indicates whether this setting is locked.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether using screen share content with OCR for webinar summaries is locked.","example":false},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are locked.","example":false},"auto_start":{"type":"boolean","description":"Whether turning on session summary automatically when sessions start is locked.","example":false}},"description":"Lock settings for Zoom Events session summary."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether the Hub AI search and file creation setting is locked.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether the Canvas AI content generation and revision setting is locked.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether the Canvas AI sentence completion setting is locked.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether the Canvas post-meeting writing task setting is locked.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Paper AI content generation and revision setting is locked.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Sheets AI content generation and revision setting is locked.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether the Zoom Sheets AI Formula setting is locked.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether the Zoom Sheets AI Function setting is locked.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether the Zoom Sheets AI Resources setting is locked.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Slides AI content generation and revision setting is locked.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether the My Notes meeting transcription setting is locked.","example":true},"my_notes_ai_content_generation":{"type":"boolean","description":"Whether the My Notes AI content generation setting is locked.","example":true},"chat_summary":{"type":"boolean","description":"Summarize with AI Companion.","example":true},"chat_compose":{"type":"boolean","description":"Compose with AI Companion.","example":true},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing users to ask webinar questions with AI is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether automatically allowing access when the webinar starts is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Who can ask questions about the webinar. The corresponding setting values are `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), and `all_participants` (All participants). The Boolean indicates whether this setting is locked.","example":false}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript. The nested Boolean properties indicate whether the corresponding setting is locked."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing hosts to generate a summary is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether turning on webinar summary automatically when the webinar starts is locked.","example":false},"email_notification":{"type":"boolean","description":"Whether sending an email notification when sharing to participants is locked.","example":false},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether restricting users from sharing summaries to those outside of the organization is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Who will automatically receive the summary. The corresponding setting values are `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), and `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions. The nested Boolean properties indicate whether the corresponding setting is locked."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether including the webinar summary in follow-up email is locked.","example":false}},"description":"Lock settings for including the webinar summary in follow-up email."}},"description":"AI lock settings for the account or group."}},"additionalProperties":false}},"additionalProperties":false,"description":"Information about the group's updated settings."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's settings were updated, in milliseconds.","format":"int64"},"old_object":{"required":["id","settings"],"type":"object","properties":{"id":{"type":"string","description":"The updated group's ID."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"boolean","description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call) setting enabled."},"toll_call":{"type":"boolean","description":"Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"call_me_and_invite_by_phone":{"type":"boolean","description":"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.","example":true},"personal_audio_conference":{"type":"boolean","description":"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.","example":true},"participant_phone_masking":{"type":"boolean","description":"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.","example":true}},"description":"The group's Audio Conference settings."},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Whether alternative hosts receive an email when they are added or removed to a meeting."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether meeting participants and hosts receive a notification when the meeting is canceled."},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether the host is notified when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether the host is notified when participants join the meeting before them."},"schedule_for_reminder":{"type":"boolean","description":"Whether the host is notified if a meeting is scheduled, rescheduled, or canceled."}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","description":"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_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether livestreaming is allowed."},"allow_show_zoom_windows":{"type":"boolean","description":"Whether Zoom windows display screen share."},"annotation":{"type":"boolean","description":"Whether meeting participants can use annotation tools to add information to shared screens."},"auto_answer":{"type":"boolean","description":"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_captions":{"type":"boolean","description":"Whether live transcription services are available to transcribe meetings."},"auto_saving_chat":{"type":"boolean","description":"Whether all in-meeting chats are automatically saved."},"breakout_room":{"type":"boolean","description":"Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms)."},"chat":{"type":"boolean","description":"Whether meeting participants can send chat messages that are visible to all participants."},"closed_caption":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"co_host":{"type":"boolean","description":"Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host."},"custom_data_center_regions":{"type":"boolean","description":"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_meetings":{"type":"boolean","description":"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_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"e2e_encryption":{"type":"boolean","description":"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_chime":{"type":"boolean","description":"Whether a chime plays when participants join or leave the meeting."},"far_end_camera_control":{"type":"boolean","description":"Whether other users are allowed to take control of the camera during a meeting."},"feedback":{"type":"boolean","description":"Whether users can provide feedback to Zoom at the end of the meeting."},"file_transfer":{"type":"boolean","description":"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_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel."},"group_hd":{"type":"boolean","description":"Whether a higher quality video for host and participants is enabled. This will require more bandwidth."},"language_interpretation":{"type":"boolean","description":"Whether hosts can assign participants as interpreters who can interpret one language into another in real-time."},"sign_language_interpretation":{"type":"boolean","description":"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."},"manual_captions":{"type":"boolean","description":"Whether hosts can type closed captions or assign a participant/third party device to add closed captions."},"meeting_reactions":{"type":"boolean","description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar."},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel."},"original_audio":{"type":"boolean","description":"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."},"polling":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether meeting participants can send private 1:1 chat message other meeting participants."},"remote_control":{"type":"boolean","description":"During screen sharing, whether the person who is presenting can let others control the shared content."},"remote_support":{"type":"boolean","description":"Whether the meeting host can provide 1:1 remote support to another participant."},"request_permission_to_unmute":{"type":"boolean","description":"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_caption":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"save_captions":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"screen_sharing":{"type":"boolean","description":"Whether hosts and participants can share their screen or content during meetings."},"sending_default_email_invites":{"type":"boolean","description":"Whether users can invite participants by email only by default."},"show_a_join_from_your_browser_link":{"type":"boolean","description":"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_link":{"type":"boolean","description":"Whether participants can join a meeting directly from their browser."},"show_meeting_control_toolbar":{"type":"boolean","description":"Whether to always display the meeting controls toolbar during a meeting."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"stereo_audio":{"type":"boolean","description":"Whether users can select stereo audio during a meeting."},"use_html_format_email":{"type":"boolean","description":"Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin."},"virtual_background":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"waiting_room":{"type":"boolean","description":"Whether participants cannot join a meeting until the host admits them from the waiting room."},"webinar_chat":{"type":"boolean","description":"Whether webinar participants can send chat messages."},"webinar_live_streaming":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"webinar_polling":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"webinar_survey":{"type":"boolean","description":"Whether the host can present surveys to attendees once a webinar has ended."},"whiteboard":{"type":"boolean","description":"Whether participants can share a whiteboard that includes annotation tools."}}},"other_options":{"type":"object","properties":{"blur_snapshot":{"type":"boolean","description":"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."}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Whether cloud recordings are accessible to account members."},"auto_delete_cmr":{"type":"boolean","description":"Whether Zoom automatically deletes recordings permanently after a specified number of days."},"auto_recording":{"type":"boolean","description":"Whether meetings are automatically recorded when they begin."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meetings and webinars in the cloud."},"cloud_recording_download":{"type":"boolean","description":"Whether anyone with a link to the cloud recording can download the file."},"host_delete_cloud_recording":{"type":"boolean","description":"Whether the host can delete cloud recordings. If `false`, only the admin can delete cloud recordings."},"ip_address_access_control":{"type":"boolean","description":"Whether cloud recording access is only available for a specific range of IP addresses."},"local_recording":{"type":"boolean","description":"Whether hosts and participants can record meetings to a local file."},"prevent_host_access_recording":{"type":"boolean","description":"Whether hosts can access and view their meetings' cloud recordings."},"recording_authentication":{"type":"boolean","description":"Whether only authenticated users can view cloud recordings."},"archive":{"type":"boolean","description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team."}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Whether participants can join only the audio portion of meetings."},"embed_password_in_join_link":{"type":"boolean","description":"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_password":{"type":"boolean","description":"Whether passwords are required to join before the host in personal meetings."},"host_video":{"type":"boolean","description":"Whether host video defaults to on when they join meetings."},"join_before_host":{"type":"boolean","description":"Whether participants can join meetings before the host."},"meeting_authentication":{"type":"boolean","description":"Whether only authenticated users can join meetings."},"mute_upon_entry":{"type":"boolean","description":"Whether all participants are automatically muted when they join meetings."},"participant_video":{"type":"boolean","description":"Whether participant video defaults to on when they join meetings."},"pstn_password_protected":{"type":"boolean","description":"Whether new passwords are generated and sent for newly-scheduled or edited meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled."},"require_password_for_pmi_meetings":{"type":"boolean","description":"Whether participants are required to enter a password for PMI meetings."},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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_reminder":{"type":"boolean","description":"Whether desktop notifications for upcoming meetings is enabled."}}},"telephony":{"type":"object","properties":{"telephony_regions":{"type":"boolean","description":"Whether telephony regions are enabled for meetings."},"third_party_audio":{"type":"boolean","description":"Whether users can join meetings using the existing third party audio configurations."}},"description":"Group Settings: Telephony."},"meeting_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"boolean","description":"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_security":{"type":"boolean","description":"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_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars."},"embed_password_in_join_link":{"type":"boolean","description":"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_type":{"type":"string","description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether end-to-end encryption is enabled for meetings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether only authenticated users can join meetings from the web client."},"phone_password":{"type":"boolean","description":"Whether passwords are required for participants joining by phone. \n\n 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_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"waiting_room":{"type":"boolean","description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n 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_password":{"type":"boolean","description":"Whether a password is generated when scheduling webinars. Participants must use the password to join the scheduled webinar."}}},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether the screen_share_ocr setting is locked.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether the meeting_chat_messages setting is locked.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether the full_display_names_in_ai_assets setting is locked.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether the ai_generated_virtual_backgrounds setting is locked.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether the meeting_agenda setting is locked.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is locked.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether sharing generated Zoom Docs with meeting summary recipients is locked.","example":false}},"description":"Lock settings for meeting summary Docs."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are locked.","example":true}},"description":"Lock settings for phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is locked.","example":true}},"description":"Lock settings for meeting summary retention."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is locked.","example":true}},"description":"Lock settings for Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is locked.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording for joined third-party meetings is locked.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is locked.","example":true}},"description":"Lock settings for calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is locked.","example":true}},"description":"Lock settings for pre-meeting email notification."}},"description":"Lock settings for third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Smart Recording is locked.","example":true}},"description":"Lock settings for Smart Recording."},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether task creation and management with AI is locked.","example":true}},"description":"Lock settings for task creation and management with AI."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is locked.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate availability is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI conversation retention period is locked.","example":true}},"description":"Lock settings for the conversational AI companion."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion in the AI panel is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI panel conversation retention period is locked.","example":true}},"description":"Lock settings for the AI panel in Zoom Workplace."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is locked.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources are locked.","example":true}},"description":"Lock settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources are locked.","example":true}},"description":"Lock settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether Web content as an AI data source is locked.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether Local file uploads as an AI data source are locked.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether allowing AI to consume the organization's custom dictionaries is locked.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether allowing AI to perform tasks in third-party apps is locked.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Whether the participant_can_request_aic_in_meeting setting is locked.","example":false},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Whether the restrict_aic_when_external_user_join_meeting setting is locked.","example":false},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"Whether the restrict_aic_when_restrict_user_join setting is locked.","example":false},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether restrictions on joining AI-enabled meetings are locked.","example":false}},"description":"Lock settings for restrictions on joining AI-enabled meetings."},"meeting_questions":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether meeting questions are locked.","example":false},"auto_enable_locked":{"type":"boolean","description":"Whether automatic meeting questions are locked.","example":false},"who_can_ask_questions_locked":{"type":"boolean","description":"Whether the meeting questions participant scope is locked.","example":false}},"description":"Lock settings for meeting questions."},"meeting_summary":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether meeting summaries are locked.","example":false},"auto_enable_locked":{"type":"boolean","description":"Whether automatic meeting summaries are locked.","example":false},"who_will_receive_summary_locked":{"type":"boolean","description":"Whether the meeting summary recipient scope is locked.","example":false}},"description":"Lock settings for meeting summaries."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary templates are locked.","example":false}},"description":"Lock settings for meeting summary templates."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the default meeting summary language is locked.","example":false}},"description":"Lock settings for the default meeting summary language."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary IP access is locked.","example":false}},"description":"Lock settings for meeting summary IP access."},"remind_me_turn_on_aic":{"type":"boolean","description":"Whether the remind_me_turn_on_aic setting is locked.","example":false},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"Whether the remind_me_turn_on_catch_me_up setting is locked.","example":false},"meeting_summary_email_only_mode":{"type":"boolean","description":"Whether the meeting_summary_email_only_mode setting is locked.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"Whether the restrict_users_from_deleting_ai_companion_assets setting is locked.","example":false},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"Whether the restrict_users_from_editing_ai_companion_assets setting is locked.","example":false},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`. The Boolean indicates whether this setting is locked.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether using screen share content with OCR for webinar summaries is locked.","example":false},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are locked.","example":false},"auto_start":{"type":"boolean","description":"Whether turning on session summary automatically when sessions start is locked.","example":false}},"description":"Lock settings for Zoom Events session summary."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether the Hub AI search and file creation setting is locked.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether the Canvas AI content generation and revision setting is locked.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether the Canvas AI sentence completion setting is locked.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether the Canvas post-meeting writing task setting is locked.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Paper AI content generation and revision setting is locked.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Sheets AI content generation and revision setting is locked.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether the Zoom Sheets AI Formula setting is locked.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether the Zoom Sheets AI Function setting is locked.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether the Zoom Sheets AI Resources setting is locked.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Slides AI content generation and revision setting is locked.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether the My Notes meeting transcription setting is locked.","example":true},"my_notes_ai_content_generation":{"type":"boolean","description":"Whether the My Notes AI content generation setting is locked.","example":true},"chat_summary":{"type":"boolean","description":"Summarize with AI Companion.","example":true},"chat_compose":{"type":"boolean","description":"Compose with AI Companion.","example":true},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing users to ask webinar questions with AI is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether automatically allowing access when the webinar starts is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Who can ask questions about the webinar. The corresponding setting values are `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), and `all_participants` (All participants). The Boolean indicates whether this setting is locked.","example":false}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript. The nested Boolean properties indicate whether the corresponding setting is locked."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing hosts to generate a summary is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether turning on webinar summary automatically when the webinar starts is locked.","example":false},"email_notification":{"type":"boolean","description":"Whether sending an email notification when sharing to participants is locked.","example":false},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether restricting users from sharing summaries to those outside of the organization is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Who will automatically receive the summary. The corresponding setting values are `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), and `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions. The nested Boolean properties indicate whether the corresponding setting is locked."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether including the webinar summary in follow-up email is locked.","example":false}},"description":"Lock settings for including the webinar summary in follow-up email."}},"description":"AI lock settings for the account or group."}},"additionalProperties":false,"description":"Information about the group's previous settings. This only returns modified settings."}},"additionalProperties":false,"description":"Information about the group's previous settings."}},"additionalProperties":false}},"additionalProperties":false},"Group.admin_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that removed the admin from the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that removed the admin from the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's admin were deleted, in milliseconds.","format":"int64"},"object":{"required":["admins","id"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"admins":{"type":"array","description":"Information about the group admins.","items":{"type":"object","properties":{"id":{"type":"string","description":"The admins's user ID."},"email":{"type":"string","description":"The admin's email address.","format":"email"}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"Group.member_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that removed members from the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that removed members from the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's members were deleted, in milliseconds.","format":"int64"},"object":{"required":["id","members"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"members":{"type":"array","description":"Information about the members removed from the group.","items":{"type":"object","properties":{"id":{"type":"string","description":"The member's user ID."},"email":{"type":"string","description":"The member's email address.","format":"email"}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"User.deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the user was deleted."},"operator":{"type":"string","description":"The email address of the user that deleted the user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the user."},"object":{"required":["email","id","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the deleted user."}},"additionalProperties":false}},"additionalProperties":false},"User.deactivatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the user was deactivated."},"operator":{"type":"string","description":"The email address of the user that deactivated the user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deactivated the user."},"object":{"required":["email","first_name","id","last_name","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the deactivated user."}},"additionalProperties":false}},"additionalProperties":false},"User.settings_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"operator":{"type":"string","description":"The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997).","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the settings."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the setting was updated."},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account that updated the settings."},"operator":{"type":"string","description":"The email address of the user who [disassociated the user](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066997).","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the settings."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the setting was updated."},"object":{"required":["id","settings"],"type":"object","properties":{"id":{"type":"string","description":"The modified user's unique ID (`userId`)."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to mask phone numbers of users dialing into a meeting in the participant list."},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"]}},"description":"Information about the participant phone masking settings."}},"description":"Information about the audio conferencing settings."},"schedule_meeting":{"type":"object","properties":{"host_video":{"type":"boolean","description":"Whether to start meetings with the host video on."},"participants_video":{"type":"boolean","description":"Whether to start meetings with the participant video on."},"audio_type":{"type":"string","description":"The type of audio used to join the meeting."},"join_before_host":{"type":"boolean","description":"Whether participants can join the meeting before its host."},"force_pmi_jbh_password":{"type":"string","description":"Whether to require a password for personal meetings if attendees can join before host."},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting."},"pstn_password_protected":{"type":"string","description":"Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449)."},"jbh_time":{"type":"integer","description":"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:\n\n* `0` — Allow the participant to join the meeting at anytime.\n* `5` — Allow the participant to join 5 minutes before the meeting's start time.\n* `10` — Allow the participant to join 10 minutes before the meeting's start time.","enum":[0,5,10,15]},"personal_meeting":{"type":"boolean","description":"The personal meeting settings:\n* `true` — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings.\n* `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.\n\n**For Zoom Phone only:**\n\nIf a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled."},"default_password_for_scheduled_meetings":{"type":"boolean","description":"Whether to use the default password for already scheduled meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"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.\n\nIf instant meetings use a PMI, this option is **disabled**."},"mute_upon_entry":{"type":"boolean","description":"Whether to automatically mute all participants when they join the meeting."},"require_password_for_pmi_meetings":{"type":"string","description":"Require participants to enter password for PMI meetings:\n* `jbh_only` — Only when a participant joins before the host.\n* `all` — All participants must enter a password to join the meeting.\n* `none` — No password required.","enum":["jbh_only","all","none"]},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Whether PMI is enabled for all instant meetings."},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Require a passcode for meetings which have already been scheduled\n","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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.\n\nThis setting only applies to regular meetings that do **not** use a PMI."},"pmi_password":{"type":"string","description":"The PMI's password."},"upcoming_meeting_reminder":{"type":"boolean","description":"Whether to receive a desktop notification for upcoming meetings."}},"additionalProperties":false,"description":"Information about the scheduled meeting settings."},"in_meeting":{"type":"object","properties":{"e2e_encryption":{"type":"boolean","description":"Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings."},"chat":{"type":"boolean","description":"Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400)."},"post_meeting_feedback":{"type":"boolean","description":"Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting."},"whiteboard":{"type":"boolean","description":"Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature."},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_participants_chat_with":{"type":"integer","description":"Whether participants can chat with certain groups:\n* `1` — The participants cannot use chat.\n* `2` — Host and co-hosts only.\n * `3` — The participants can chat with other participants publicly.\n* `4` - The participants can chat with other participants publicly and privately.\n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4]},"allow_users_save_chats":{"type":"integer","description":"Whether participants can save meeting chats:\n* `1` — Participants cannot save meeting chats.\n* `2` — Participants can only save host and co-host meeting chats.\n* `3` — Participants can save all meeting chats.","enum":[1,2,3]},"private_chat":{"type":"boolean","description":"Whether meeting participants can use private chat."},"attention_mode_focus_mode":{"type":"boolean","description":"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."},"allow_host_to_enable_focus_mode":{"type":"boolean","description":"Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting."},"auto_saving_chat":{"type":"boolean","description":"Whether to automatically save all in-meeting chats."},"entry_exit_chime":{"type":"string","description":"The sound that plays when participants join or leave the meeting:\n* `host` — Chime when host joins or leaves a meeting.\n* `all` — Chime when any participant joins or leaves a meeting.\n* `none` — Do not chime."},"record_play_voice":{"type":"boolean","description":"When a participant joins by telephone, whether recording and playing the participant's own voice is enabled."},"file_transfer":{"type":"boolean","description":"Whether file sharing via in-meeting chat is enabled."},"feedback":{"type":"boolean","description":"Whether users can send feedback to Zoom at the end of the meeting."},"co_host":{"type":"boolean","description":"Whether to allow the meeting host to add co-hosts."},"polling":{"type":"boolean","description":"Whether polls are available in the meeting controls."},"meeting_polling":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can add polls before or during a meeting."},"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true}},"description":"Information about the account's meeting polling settings."},"attendee_on_hold":{"type":"boolean","description":"Whether hosts can temporarily remove an attendee from a meeting."},"annotation":{"type":"boolean","description":"Whether participants can use annotation tools to add information to shared screens."},"remote_control":{"type":"boolean","description":"Whether users can request remote control."},"non_verbal_feedback":{"type":"boolean","description":"Whether non-verbal feedback through screensharing is enabled."},"breakout_room":{"type":"boolean","description":"Whether the host can split meeting participants into separate, smaller rooms."},"breakout_room_schedule":{"type":"boolean","description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher."},"remote_support":{"type":"boolean","description":"Whether the host can provide 1:1 remote support to a participant."},"screen_sharing":{"type":"boolean","description":"Whether to allow hosts and participants to share their screen or content during meetings.","example":true},"who_can_share_screen":{"type":"string","description":"The type of user who can share their screen or content during meetings: \n* `host` — Only hosts can screen share. \n* `all` — Both hosts and participants can screen share.","example":"all","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","description":"The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \n* `host` — Only hosts can screen share when someone else is sharing. \n* `all` — Both hosts and participants can screen share when someone else is sharing.","example":"host","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can screen share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can screen share at a time\n.<br>\n`multiple`: Multiple participants can screen share simultaneously (dual monitors recommended).","example":"multiple","enum":["multiple","one"]},"closed_caption":{"type":"boolean","description":"Whether closed captions are enabled."},"group_hd":{"type":"boolean","description":"Whether group HD video is enabled."},"far_end_camera_control":{"type":"boolean","description":"Whether another user can take control of camera during a meeting."},"share_dual_camera":{"type":"boolean","description":"Share dual camera.\n\nThis field is **deprecated**.","deprecated":true},"waiting_room":{"type":"boolean","description":"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."},"virtual_background":{"type":"boolean","description":"Whether users can change their background."},"virtual_background_settings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether virtual backgrounds are enabled."},"allow_videos":{"type":"boolean","description":"Whether the use of videos for virtual backgrounds is enabled."},"allow_upload_custom":{"type":"boolean","description":"Whether users can upload custom backgrounds."},"files":{"type":"array","description":"Information about virtual background files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The file's unique ID."},"name":{"type":"string","description":"The file's name."},"type":{"type":"string","description":"The file's type."},"is_default":{"type":"boolean","description":"Whether the file is the default virtual background file."},"size":{"type":"integer","description":"The file' size."}},"description":"Information about a virtual background file."}}},"description":"Information about the virtual background settings."},"custom_data_center_regions":{"type":"boolean","description":"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: \n* `true` — Enabled. Provide the data center regions in the `data_center_regions` field. \n* `false` — Disabled. Only use the default data center regions."},"data_center_regions":{"type":"array","description":"The user's selected custom data center regions. This field only returns if the `custom_data_center_regions` value is `true`: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can assign participants as interpreters to interpret one language into another in real-time."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string"},"enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string"}}},"description":"Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings."},"meeting_reactions":{"type":"boolean","description":"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_emojis":{"type":"string","description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `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) ","example":"all","enum":["all","selected"]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395).","example":true},"show_a_join_from_your_browser_link":{"type":"boolean","description":"Whether participants can join a meeting directly from their browser and bypass the Zoom application download process."},"join_from_mobile":{"type":"boolean","description":"Whether participants can join a meeting directly from their mobile browser."},"join_from_desktop":{"type":"boolean","description":"Whether participants can join a meeting directly from their desktop browser."},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming."},"live_streaming_facebook":{"type":"boolean","description":"Whether to allow Facebook livestreaming."},"workplace_by_facebook":{"type":"boolean","description":"Whether to allow Workplace by Facebook livestreaming."},"live_streaming_youtube":{"type":"boolean","description":"Whether to allow YouTube livestreaming."},"custom_live_streaming_service":{"type":"boolean","description":"Whether to allow custom livestreaming."},"custom_service_instructions":{"type":"string","description":"The custom livestreaming service instructions."},"webinar_live_streaming":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"live_streaming_service":{"type":"array","description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]}},"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"live_streaming_reminder":{"type":"boolean","description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol)."}},"description":"Whether webinar livestreaming is enabled."},"webinar_chat":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether webinar participants can send chat messages."},"allow_panelists_chat_with":{"type":"integer","description":"Webinar panelists can chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2]},"allow_attendees_chat_with":{"type":"integer","description":"Webinar attendees can chat with:\n* `1` — No one.\n* `2` — Host and all panelists.\n* `3` — Everyone.","enum":[1,2,3]},"default_attendees_chat_with":{"type":"integer","description":"By default, webinar attendees can chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether webinar panelists can send direct messages to other panelists."},"allow_users_save_chats":{"type":"integer","description":"Whether webinar attendees can save chats:\n* `0` — Attendees cannot save chats.\n* `1` — Attendees can only save host and panelist chats.\n* `2` — Attendees can save all chats.","enum":[0,1,2]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends."}},"description":"Whether webinar participants can send chat messages."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.","example":true},"enable_sign_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler.","example":true},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string","example":"American","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]}},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string","example":"Language1"}}},"description":"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."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_captioning":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning."},"third_party_captioning_service":{"type":"boolean","description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services."},"auto_transcribing":{"type":"boolean","description":"Whether to allow a live transcription service to transcribe meetings."},"view_full_transcript":{"type":"boolean","description":"Whether to allow the viewing of full transcripts in the in-meeting side panel."},"save_caption":{"type":"boolean","description":"Whether to allow participants to save closed captions or transcripts."}},"description":"Information about the closed captioning settings."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"meeting_survey":{"type":"boolean","description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher."},"webinar_polling":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."},"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true}},"description":"Information about the account's webinar polling settings."},"webinar_survey":{"type":"boolean","description":"Whether to allow the host to present surveys to attendees once a webinar has ended."},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether the **Disable desktop screen sharing for meetings you host** setting is enabled."},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"auto_answer":{"type":"boolean","description":"Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled."},"allow_show_zoom_windows":{"type":"boolean","description":"Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled."}},"additionalProperties":false,"description":"Information about the in meeting settings."},"email_notification":{"type":"object","properties":{"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available."},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available."},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether to notify the host when participants join the meeting before them."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether to notify the host and participants when a meeting is canceled."},"alternative_host_reminder":{"type":"boolean","description":"Whether to notify when an alternative host is added to or removed from a meeting."},"schedule_for_reminder":{"type":"boolean","description":"Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled."}},"additionalProperties":false,"description":"Information about the email notification settings."},"recording":{"type":"object","properties":{"local_recording":{"type":"boolean","description":"Whether hosts and participants can record the meeting using a local file."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meeting or webinar in the cloud."},"record_speaker_view":{"type":"boolean","description":"Whether recording the active speaker with a shared screen is enabled."},"record_gallery_view":{"type":"boolean","description":"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_audio_file":{"type":"boolean","description":"Whether recording an audio-only file is enabled."},"save_chat_text":{"type":"boolean","description":"Whether saving the chat text from the meeting to the cloud is enabled."},"show_timestamp":{"type":"boolean","description":"Whether adding a timestamp to the recording is enabled."},"recording_audio_transcript":{"type":"boolean","description":"Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled."},"auto_recording":{"type":"string","description":"The automatic recording setting:\n* `local` — Record locally\n* `cloud` — Record on the cloud.\n* `none` — Disabled.","enum":["local","cloud","none"]},"auto_delete_cmr":{"type":"boolean","description":"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_days":{"type":"integer","description":"When the `auto_delete_cmr` value is `true`, this value is the number of days before the auto-deletion of cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120]},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled."},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled."},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled."}},"description":"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."},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording."},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen."},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files."},"recording_highlight":{"type":"boolean","description":"Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled."},"save_panelist_chat":{"type":"boolean","description":"Whether panelist chats are saved to the recording."},"save_poll_results":{"type":"boolean","description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar."},"save_close_caption":{"type":"boolean","description":"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."},"record_audio_file_each_participant":{"type":"boolean","description":"Whether to record separate audio files for each participant is enabled."},"host_pause_stop_recording":{"type":"boolean","description":"Whether the meeting's host can pause or stop the cloud's auto recording is enabled."},"recording_disclaimer":{"type":"boolean","description":"Whether to display a disclaimer to participants before a recording begins is enabled."},"ask_participants_to_consent_disclaimer":{"type":"boolean","description":"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`."},"ask_host_to_confirm_disclaimer":{"type":"boolean","description":"Whether to ask the host to confirm the recording disclaimer is enabled."},"recording_password_requirement":{"type":"object","properties":{"length":{"maximum":10,"type":"integer","description":"The password's minimum required length."},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one alphabetical letter."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character (for example, `!`, `@`, or `#`)."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."}},"description":"Information about the minimum password requirements for recordings via the Account Recording settings."},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"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_ranges":{"type":"string","description":"The IP addresses or ranges that have access to the cloud recordings."}},"description":"Information about the settings to allow cloud recording access only from specific IP address ranges."}},"additionalProperties":false,"description":"Information about recording settings."},"telephony":{"type":"object","properties":{"third_party_audio":{"type":"boolean","description":"Whether users can join the meeting using an existing third-party audio configuration."},"audio_conference_info":{"maxLength":2048,"type":"string","description":"Information about the third-party audio configuration."},"show_international_numbers_link":{"type":"boolean","description":"Whether to display the international numbers link on the invitation email."},"telephony_regions":{"type":"object","properties":{"allowed_values":{"type":"array","description":"The telephony region options provided by Zoom.","items":{"type":"string"}},"selection_values":{"type":"string","description":"The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting."}},"description":"Information about where most of the participants call into or call from during a meeting."}},"additionalProperties":false,"description":"Information about telephony settings."},"feature":{"type":"object","properties":{"meeting_capacity":{"type":"integer","description":"The user's meeting capacity."},"large_meeting":{"type":"boolean","description":"Whether the large meeting feature is enabled."},"large_meeting_capacity":{"type":"integer","description":"The capacity for the user's large meetings:\n* `500`\n* `1000`","enum":[500,1000]},"webinar":{"type":"boolean","description":"Whether the user has the Webinar feature."},"webinar_capacity":{"type":"integer","description":"If the user has a Webinar capacity plan subscription, the user's Webinar capacity:\n* `100`\n* `500`\n* `1000`\n* `3000`\n* `5000`\n* `10000`","enum":[100,500,1000,3000,5000,10000]},"zoom_events":{"type":"boolean","description":"Whether the user has the Zoom Events feature."},"zoom_events_capacity":{"type":"integer","description":"If the user has the Zoom Events feature, the user's Zoom Events plan capacity:\n* `500`\n* `1000`\n* `3000`\n* `5000`\n* `10000`\n* `20000`\n* `30000`\n* `50000`","enum":[500,1000,3000,5000,10000,20000,30000,50000]},"cn_meeting":{"type":"boolean","description":"Host meeting in China.","deprecated":true},"in_meeting":{"type":"boolean","description":"Host meeting in India.","deprecated":true},"zoom_phone":{"type":"boolean","description":"Whether the Zoom Phone feature is enabled."},"concurrent_meeting":{"type":"string","description":"The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: \n* `Basic` \n* `Plus` \n* `None` \n\n **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription.","enum":["Basic","Plus","None"]}},"additionalProperties":false,"description":"Information about the features available to the user."},"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts."},"waiting_room":{"type":"boolean","description":"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. \n\n 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_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `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).","enum":[0,1,2]},"whitelisted_domains_for_waiting_room":{"type":"string","description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`)."},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1]}},"description":"Information about the waiting room settings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting."},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether to require a password for meetings that have already been scheduled."},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"phone_password":{"type":"boolean","description":"Whether to require a password for participants joining by phone. \n\n 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."},"webinar_password":{"type":"boolean","description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar."},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether to require a password for webinars that have already been scheduled."},"meeting_password_requirement":{"type":"object","properties":{"length":{"type":"integer","description":"The password's minimum length."},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one letter character."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether the password must include uppercase and lowercase characters."},"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `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`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8]},"weak_enhance_detection":{"type":"boolean","description":"Whether users will be informed when the provided password is weak."}},"description":"Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160)."},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password."},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field."},"encryption_type":{"type":"string","description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `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.","enum":["enhanced_encryption","e2ee"]},"block_user_domain":{"type":"boolean","description":"Whether to block users in specific domains from joining meetings and webinars."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client."},"block_user_domain_list":{"maxItems":20,"type":"array","description":"The domain to block, up to 20 domains. For example, the `*.example.com` domain.","items":{"maxLength":30,"minLength":5,"type":"string"}}},"description":"Whether to require that all meetings are secured with at least one security option."},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"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_countries":{"type":"array","description":"A list of countries and regions to which the user can call out to.","items":{"type":"string"}},"show_international_numbers_link":{"type":"boolean","description":"Whether to show the international numbers link in the email invitation."},"display_toll_free_numbers":{"type":"boolean","description":"Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client."},"global_dial_in_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"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":{"type":"object","properties":{"code":{"type":"string","description":"The code of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"Information about the global dial-in countries settings."}},"description":"Information about the Telephony Service Provider (TSP) settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Allow participants to request AI Companion in a meeting.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Restrict AI Companion when an external user joins a meeting.","example":true},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can ask questions in a meeting with AI.","example":true},"auto_enable":{"type":"boolean","description":"Automatically start meeting questions when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Participants allowed to ask meeting questions. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (organization participants from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can generate a meeting summary.","example":true},"auto_enable":{"type":"boolean","description":"Auto-start the meeting summary when the meeting starts.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing a meeting summary with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether the meeting summary email includes summary text. Valid values: `include_full_text_in_email` (include the summary text), `not_include_full_text_in_email` (do not include the summary text).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing meeting summaries with people outside the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Audience restricted from sharing meeting summaries. Valid values: `external_users` (users outside the organization), `all_users` (all users), `all_users_except_delegate` (all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Recipients for automatically shared meeting summaries. Valid values: `host` (only the meeting host), `alt_host` (meeting host, co-hosts, and alternative hosts), `organization` (meeting host and invitees in the organization), `all` (all meeting invitees, including external invitees), `host_and_panelist_in_organization` (meeting host and participants in the organization), `host_and_panelist_not_in_organization` (meeting host and all participants, including external participants), `host_and_speakers` (meeting host and speakers), `do_not_share` (do not share a summary).","example":"alt_host","enum":["host","alt_host","organization","all","host_and_panelist_in_organization","host_and_panelist_not_in_organization","host_and_speakers","do_not_share"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings.","example":true},"summary_template_id":{"type":"string","description":"ID of the default meeting summary template used to generate meeting summaries.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summaries automatically use the selected default language.","example":true},"language":{"type":"string","description":"Language that meeting summaries automatically use when the default-language setting is enabled. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en-US"}},"description":"Set the default language for meeting summaries."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether access to meeting summaries is restricted to specified IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are enabled."},"day_recommendation":{"type":"boolean","description":"Whether day recommendations are enabled."},"desk_recommendation":{"type":"boolean","description":"Whether desk recommendations are enabled."},"custom_workspaces_recommendation":{"type":"boolean","description":"Whether custom workspace recommendations are enabled."},"room_recommendation":{"type":"boolean","description":"Whether room recommendations are enabled."},"proactive_room_recommendation":{"type":"boolean","description":"Whether proactive room recommendations are enabled."}},"description":"Workspace Reservation recommendations with AI."},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true}},"description":"My Notes AI content generation settings."},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only the webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include the summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Whether to restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Who to automatically share the summary with. Valid values: `host` (Only the webinar host), `host_and_panelist_in_organization` (Only the webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (The webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."}},"description":"AI settings."}},"additionalProperties":false}},"additionalProperties":false,"description":"Information about the user."},"old_object":{"type":"object","properties":{"id":{"type":"string","description":"The modified user's unique ID (`userId`)."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to mask phone numbers of users dialing into a meeting in the participant list."},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"]}},"description":"Information about the participant phone masking settings."}},"description":"Information about the audio conferencing settings."},"schedule_meeting":{"type":"object","properties":{"host_video":{"type":"boolean","description":"Whether to start meetings with the host video on."},"participants_video":{"type":"boolean","description":"Whether to start meetings with the participant video on."},"audio_type":{"type":"string","description":"The type of audio used to join the meeting."},"join_before_host":{"type":"boolean","description":"Whether participants can join the meeting before its host."},"force_pmi_jbh_password":{"type":"string","description":"Whether to require a password for personal meetings if attendees can join before host."},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a [PMI (Personal Meeting ID)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) to schedule meeting."},"pstn_password_protected":{"type":"string","description":"Require a password from participants before joining a meeting via [PSTN](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449)."},"jbh_time":{"type":"integer","description":"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:\n\n* `0` — Allow the participant to join the meeting at anytime.\n* `5` — Allow the participant to join 5 minutes before the meeting's start time.\n* `10` — Allow the participant to join 10 minutes before the meeting's start time.","enum":[0,5,10,15]},"personal_meeting":{"type":"boolean","description":"The personal meeting settings:\n* `true` — Indicates that the **Enable Personal Meeting ID** setting is enabled. Users can use a personal meeting ID for their meetings.\n* `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.\n\n**For Zoom Phone only:**\n\nIf a user has been assigned a desk phone, the desk phone's **Elevate to Zoom Meeting** setting will be disabled."},"default_password_for_scheduled_meetings":{"type":"boolean","description":"Whether to use the default password for already scheduled meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"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.\n\nIf instant meetings use a PMI, this option is **disabled**."},"mute_upon_entry":{"type":"boolean","description":"Whether to automatically mute all participants when they join the meeting."},"require_password_for_pmi_meetings":{"type":"string","description":"Require participants to enter password for PMI meetings:\n* `jbh_only` — Only when a participant joins before the host.\n* `all` — All participants must enter a password to join the meeting.\n* `none` — No password required.","enum":["jbh_only","all","none"]},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Whether PMI is enabled for all instant meetings."},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Require a passcode for meetings which have already been scheduled\n","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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.\n\nThis setting only applies to regular meetings that do **not** use a PMI."},"pmi_password":{"type":"string","description":"The PMI's password."},"upcoming_meeting_reminder":{"type":"boolean","description":"Whether to receive a desktop notification for upcoming meetings."}},"additionalProperties":false,"description":"Information about the scheduled meeting settings."},"in_meeting":{"type":"object","properties":{"e2e_encryption":{"type":"boolean","description":"Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings."},"chat":{"type":"boolean","description":"Whether meeting participants can use [in-meeting chat](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400)."},"post_meeting_feedback":{"type":"boolean","description":"Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting."},"whiteboard":{"type":"boolean","description":"Whether to enable the [classic whiteboard](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068305) feature."},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_participants_chat_with":{"type":"integer","description":"Whether participants can chat with certain groups:\n* `1` — The participants cannot use chat.\n* `2` — Host and co-hosts only.\n * `3` — The participants can chat with other participants publicly.\n* `4` - The participants can chat with other participants publicly and privately.\n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4]},"allow_users_save_chats":{"type":"integer","description":"Whether participants can save meeting chats:\n* `1` — Participants cannot save meeting chats.\n* `2` — Participants can only save host and co-host meeting chats.\n* `3` — Participants can save all meeting chats.","enum":[1,2,3]},"private_chat":{"type":"boolean","description":"Whether meeting participants can use private chat."},"attention_mode_focus_mode":{"type":"boolean","description":"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."},"allow_host_to_enable_focus_mode":{"type":"boolean","description":"Whether the host can enable [**Focus Mode**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004) when scheduling a meeting."},"auto_saving_chat":{"type":"boolean","description":"Whether to automatically save all in-meeting chats."},"entry_exit_chime":{"type":"string","description":"The sound that plays when participants join or leave the meeting:\n* `host` — Chime when host joins or leaves a meeting.\n* `all` — Chime when any participant joins or leaves a meeting.\n* `none` — Do not chime."},"record_play_voice":{"type":"boolean","description":"When a participant joins by telephone, whether recording and playing the participant's own voice is enabled."},"file_transfer":{"type":"boolean","description":"Whether file sharing via in-meeting chat is enabled."},"feedback":{"type":"boolean","description":"Whether users can send feedback to Zoom at the end of the meeting."},"co_host":{"type":"boolean","description":"Whether to allow the meeting host to add co-hosts."},"polling":{"type":"boolean","description":"Whether polls are available in the meeting controls."},"meeting_polling":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can add polls before or during a meeting."},"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true}},"description":"Information about the account's meeting polling settings."},"attendee_on_hold":{"type":"boolean","description":"Whether hosts can temporarily remove an attendee from a meeting."},"annotation":{"type":"boolean","description":"Whether participants can use annotation tools to add information to shared screens."},"remote_control":{"type":"boolean","description":"Whether users can request remote control."},"non_verbal_feedback":{"type":"boolean","description":"Whether non-verbal feedback through screensharing is enabled."},"breakout_room":{"type":"boolean","description":"Whether the host can split meeting participants into separate, smaller rooms."},"breakout_room_schedule":{"type":"boolean","description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher."},"remote_support":{"type":"boolean","description":"Whether the host can provide 1:1 remote support to a participant."},"screen_sharing":{"type":"boolean","description":"Whether to allow hosts and participants to share their screen or content during meetings.","example":true},"who_can_share_screen":{"type":"string","description":"The type of user who can share their screen or content during meetings: \n* `host` — Only hosts can screen share. \n* `all` — Both hosts and participants can screen share.","example":"all","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","description":"The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \n* `host` — Only hosts can screen share when someone else is sharing. \n* `all` — Both hosts and participants can screen share when someone else is sharing.","example":"host","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can screen share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can screen share at a time\n.<br>\n`multiple`: Multiple participants can screen share simultaneously (dual monitors recommended).","example":"multiple","enum":["multiple","one"]},"closed_caption":{"type":"boolean","description":"Whether closed captions are enabled."},"group_hd":{"type":"boolean","description":"Whether group HD video is enabled."},"far_end_camera_control":{"type":"boolean","description":"Whether another user can take control of camera during a meeting."},"share_dual_camera":{"type":"boolean","description":"Share dual camera.\n\nThis field is **deprecated**.","deprecated":true},"waiting_room":{"type":"boolean","description":"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."},"virtual_background":{"type":"boolean","description":"Whether users can change their background."},"virtual_background_settings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether virtual backgrounds are enabled."},"allow_videos":{"type":"boolean","description":"Whether the use of videos for virtual backgrounds is enabled."},"allow_upload_custom":{"type":"boolean","description":"Whether users can upload custom backgrounds."},"files":{"type":"array","description":"Information about virtual background files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The file's unique ID."},"name":{"type":"string","description":"The file's name."},"type":{"type":"string","description":"The file's type."},"is_default":{"type":"boolean","description":"Whether the file is the default virtual background file."},"size":{"type":"integer","description":"The file' size."}},"description":"Information about a virtual background file."}}},"description":"Information about the virtual background settings."},"custom_data_center_regions":{"type":"boolean","description":"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: \n* `true` — Enabled. Provide the data center regions in the `data_center_regions` field. \n* `false` — Disabled. Only use the default data center regions."},"data_center_regions":{"type":"array","description":"The user's selected custom data center regions. This field only returns if the `custom_data_center_regions` value is `true`: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can assign participants as interpreters to interpret one language into another in real-time."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string"},"enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string"}}},"description":"Information about the [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) settings."},"meeting_reactions":{"type":"boolean","description":"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_emojis":{"type":"string","description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `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) ","example":"all","enum":["all","selected"]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059395).","example":true},"show_a_join_from_your_browser_link":{"type":"boolean","description":"Whether participants can join a meeting directly from their browser and bypass the Zoom application download process."},"join_from_mobile":{"type":"boolean","description":"Whether participants can join a meeting directly from their mobile browser."},"join_from_desktop":{"type":"boolean","description":"Whether participants can join a meeting directly from their desktop browser."},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming."},"live_streaming_facebook":{"type":"boolean","description":"Whether to allow Facebook livestreaming."},"workplace_by_facebook":{"type":"boolean","description":"Whether to allow Workplace by Facebook livestreaming."},"live_streaming_youtube":{"type":"boolean","description":"Whether to allow YouTube livestreaming."},"custom_live_streaming_service":{"type":"boolean","description":"Whether to allow custom livestreaming."},"custom_service_instructions":{"type":"string","description":"The custom livestreaming service instructions."},"webinar_live_streaming":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"live_streaming_service":{"type":"array","description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]}},"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"live_streaming_reminder":{"type":"boolean","description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol)."}},"description":"Whether webinar livestreaming is enabled."},"webinar_chat":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether webinar participants can send chat messages."},"allow_panelists_chat_with":{"type":"integer","description":"Webinar panelists can chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2]},"allow_attendees_chat_with":{"type":"integer","description":"Webinar attendees can chat with:\n* `1` — No one.\n* `2` — Host and all panelists.\n* `3` — Everyone.","enum":[1,2,3]},"default_attendees_chat_with":{"type":"integer","description":"By default, webinar attendees can chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether webinar panelists can send direct messages to other panelists."},"allow_users_save_chats":{"type":"integer","description":"Whether webinar attendees can save chats:\n* `0` — Attendees cannot save chats.\n* `1` — Attendees can only save host and panelist chats.\n* `2` — Attendees can save all chats.","enum":[0,1,2]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends."}},"description":"Whether webinar participants can send chat messages."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.","example":true},"enable_sign_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler.","example":true},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string","example":"American","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]}},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string","example":"Language1"}}},"description":"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."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_captioning":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning."},"third_party_captioning_service":{"type":"boolean","description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services."},"auto_transcribing":{"type":"boolean","description":"Whether to allow a live transcription service to transcribe meetings."},"view_full_transcript":{"type":"boolean","description":"Whether to allow the viewing of full transcripts in the in-meeting side panel."},"save_caption":{"type":"boolean","description":"Whether to allow participants to save closed captions or transcripts."}},"description":"Information about the closed captioning settings."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"meeting_survey":{"type":"boolean","description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher."},"webinar_polling":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."},"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true}},"description":"Information about the account's webinar polling settings."},"webinar_survey":{"type":"boolean","description":"Whether to allow the host to present surveys to attendees once a webinar has ended."},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether the **Disable desktop screen sharing for meetings you host** setting is enabled."},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"auto_answer":{"type":"boolean","description":"Whether the [**Auto-answer group in chat**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067948) setting is enabled."},"allow_show_zoom_windows":{"type":"boolean","description":"Whether the [**Show Zoom windows during screen share**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059848) feature is enabled."}},"additionalProperties":false,"description":"Information about the in meeting settings."},"email_notification":{"type":"object","properties":{"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available."},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available."},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether to notify the host when participants join the meeting before them."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether to notify the host and participants when a meeting is canceled."},"alternative_host_reminder":{"type":"boolean","description":"Whether to notify when an alternative host is added to or removed from a meeting."},"schedule_for_reminder":{"type":"boolean","description":"Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled."}},"additionalProperties":false,"description":"Information about the email notification settings."},"recording":{"type":"object","properties":{"local_recording":{"type":"boolean","description":"Whether hosts and participants can record the meeting using a local file."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meeting or webinar in the cloud."},"record_speaker_view":{"type":"boolean","description":"Whether recording the active speaker with a shared screen is enabled."},"record_gallery_view":{"type":"boolean","description":"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_audio_file":{"type":"boolean","description":"Whether recording an audio-only file is enabled."},"save_chat_text":{"type":"boolean","description":"Whether saving the chat text from the meeting to the cloud is enabled."},"show_timestamp":{"type":"boolean","description":"Whether adding a timestamp to the recording is enabled."},"recording_audio_transcript":{"type":"boolean","description":"Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled."},"auto_recording":{"type":"string","description":"The automatic recording setting:\n* `local` — Record locally\n* `cloud` — Record on the cloud.\n* `none` — Disabled.","enum":["local","cloud","none"]},"auto_delete_cmr":{"type":"boolean","description":"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_days":{"type":"integer","description":"When the `auto_delete_cmr` value is `true`, this value is the number of days before the auto-deletion of cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120]},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled."},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled."},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled."}},"description":"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."},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording."},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen."},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files."},"recording_highlight":{"type":"boolean","description":"Whether the [recording highlights](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061101) feature is enabled."},"save_panelist_chat":{"type":"boolean","description":"Whether panelist chats are saved to the recording."},"save_poll_results":{"type":"boolean","description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar."},"save_close_caption":{"type":"boolean","description":"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."},"record_audio_file_each_participant":{"type":"boolean","description":"Whether to record separate audio files for each participant is enabled."},"host_pause_stop_recording":{"type":"boolean","description":"Whether the meeting's host can pause or stop the cloud's auto recording is enabled."},"recording_disclaimer":{"type":"boolean","description":"Whether to display a disclaimer to participants before a recording begins is enabled."},"ask_participants_to_consent_disclaimer":{"type":"boolean","description":"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`."},"ask_host_to_confirm_disclaimer":{"type":"boolean","description":"Whether to ask the host to confirm the recording disclaimer is enabled."},"recording_password_requirement":{"type":"object","properties":{"length":{"maximum":10,"type":"integer","description":"The password's minimum required length."},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one alphabetical letter."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character (for example, `!`, `@`, or `#`)."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."}},"description":"Information about the minimum password requirements for recordings via the Account Recording settings."},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"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_ranges":{"type":"string","description":"The IP addresses or ranges that have access to the cloud recordings."}},"description":"Information about the settings to allow cloud recording access only from specific IP address ranges."}},"additionalProperties":false,"description":"Information about recording settings."},"telephony":{"type":"object","properties":{"third_party_audio":{"type":"boolean","description":"Whether users can join the meeting using an existing third-party audio configuration."},"audio_conference_info":{"maxLength":2048,"type":"string","description":"Information about the third-party audio configuration."},"show_international_numbers_link":{"type":"boolean","description":"Whether to display the international numbers link on the invitation email."},"telephony_regions":{"type":"object","properties":{"allowed_values":{"type":"array","description":"The telephony region options provided by Zoom.","items":{"type":"string"}},"selection_values":{"type":"string","description":"The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting."}},"description":"Information about where most of the participants call into or call from during a meeting."}},"additionalProperties":false,"description":"Information about telephony settings."},"feature":{"type":"object","properties":{"meeting_capacity":{"type":"integer","description":"The user's meeting capacity."},"large_meeting":{"type":"boolean","description":"Whether the large meeting feature is enabled."},"large_meeting_capacity":{"type":"integer","description":"The capacity for the user's large meetings:\n* `500`\n* `1000`","enum":[500,1000]},"webinar":{"type":"boolean","description":"Whether the user has the Webinar feature."},"webinar_capacity":{"type":"integer","description":"If the user has a Webinar capacity plan subscription, the user's Webinar capacity:\n* `100`\n* `500`\n* `1000`\n* `3000`\n* `5000`\n* `10000`","enum":[100,500,1000,3000,5000,10000]},"zoom_events":{"type":"boolean","description":"Whether the user has the Zoom Events feature."},"zoom_events_capacity":{"type":"integer","description":"If the user has the Zoom Events feature, the user's Zoom Events plan capacity:\n* `500`\n* `1000`\n* `3000`\n* `5000`\n* `10000`\n* `20000`\n* `30000`\n* `50000`","enum":[500,1000,3000,5000,10000,20000,30000,50000]},"cn_meeting":{"type":"boolean","description":"Host meeting in China.","deprecated":true},"in_meeting":{"type":"boolean","description":"Host meeting in India.","deprecated":true},"zoom_phone":{"type":"boolean","description":"Whether the Zoom Phone feature is enabled."},"concurrent_meeting":{"type":"string","description":"The user's assigned [Concurrent Meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068522) type: \n* `Basic` \n* `Plus` \n* `None` \n\n **Note:** This feature requires a Concurrent Meeting Basic or Plus plan subscription.","enum":["Basic","Plus","None"]}},"additionalProperties":false,"description":"Information about the features available to the user."},"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts."},"waiting_room":{"type":"boolean","description":"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. \n\n 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_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `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).","enum":[0,1,2]},"whitelisted_domains_for_waiting_room":{"type":"string","description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`)."},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1]}},"description":"Information about the waiting room settings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271) meetings are **not** included in this setting."},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether to require a password for meetings that have already been scheduled."},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"phone_password":{"type":"boolean","description":"Whether to require a password for participants joining by phone. \n\n 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."},"webinar_password":{"type":"boolean","description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar."},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether to require a password for webinars that have already been scheduled."},"meeting_password_requirement":{"type":"object","properties":{"length":{"type":"integer","description":"The password's minimum length."},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one letter character."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether the password must include uppercase and lowercase characters."},"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `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`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8]},"weak_enhance_detection":{"type":"boolean","description":"Whether users will be informed when the provided password is weak."}},"description":"Information about the meeting and webinar [password requirements](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063160)."},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password."},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field."},"encryption_type":{"type":"string","description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `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.","enum":["enhanced_encryption","e2ee"]},"block_user_domain":{"type":"boolean","description":"Whether to block users in specific domains from joining meetings and webinars."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client."},"block_user_domain_list":{"maxItems":20,"type":"array","description":"The domain to block, up to 20 domains. For example, the `*.example.com` domain.","items":{"maxLength":30,"minLength":5,"type":"string"}}},"description":"Whether to require that all meetings are secured with at least one security option."},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"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_countries":{"type":"array","description":"A list of countries and regions to which the user can call out to.","items":{"type":"string"}},"show_international_numbers_link":{"type":"boolean","description":"Whether to show the international numbers link in the email invitation."},"display_toll_free_numbers":{"type":"boolean","description":"Whether hosts can see the toll-free numbers in the email invitation or in the Zoom client."},"global_dial_in_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"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":{"type":"object","properties":{"code":{"type":"string","description":"The code of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"Information about the global dial-in countries settings."}},"description":"Information about the Telephony Service Provider (TSP) settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Allow participants to request AI Companion in a meeting.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Restrict AI Companion when an external user joins a meeting.","example":true},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can ask questions in a meeting with AI.","example":true},"auto_enable":{"type":"boolean","description":"Automatically start meeting questions when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Participants allowed to ask meeting questions. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (organization participants from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can generate a meeting summary.","example":true},"auto_enable":{"type":"boolean","description":"Auto-start the meeting summary when the meeting starts.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing a meeting summary with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether the meeting summary email includes summary text. Valid values: `include_full_text_in_email` (include the summary text), `not_include_full_text_in_email` (do not include the summary text).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing meeting summaries with people outside the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Audience restricted from sharing meeting summaries. Valid values: `external_users` (users outside the organization), `all_users` (all users), `all_users_except_delegate` (all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Recipients for automatically shared meeting summaries. Valid values: `host` (only the meeting host), `alt_host` (meeting host, co-hosts, and alternative hosts), `organization` (meeting host and invitees in the organization), `all` (all meeting invitees, including external invitees), `host_and_panelist_in_organization` (meeting host and participants in the organization), `host_and_panelist_not_in_organization` (meeting host and all participants, including external participants), `host_and_speakers` (meeting host and speakers), `do_not_share` (do not share a summary).","example":"alt_host","enum":["host","alt_host","organization","all","host_and_panelist_in_organization","host_and_panelist_not_in_organization","host_and_speakers","do_not_share"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings.","example":true},"summary_template_id":{"type":"string","description":"ID of the default meeting summary template used to generate meeting summaries.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summaries automatically use the selected default language.","example":true},"language":{"type":"string","description":"Language that meeting summaries automatically use when the default-language setting is enabled. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en-US"}},"description":"Set the default language for meeting summaries."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether access to meeting summaries is restricted to specified IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are enabled."},"day_recommendation":{"type":"boolean","description":"Whether day recommendations are enabled."},"desk_recommendation":{"type":"boolean","description":"Whether desk recommendations are enabled."},"custom_workspaces_recommendation":{"type":"boolean","description":"Whether custom workspace recommendations are enabled."},"room_recommendation":{"type":"boolean","description":"Whether room recommendations are enabled."},"proactive_room_recommendation":{"type":"boolean","description":"Whether proactive room recommendations are enabled."}},"description":"Workspace Reservation recommendations with AI."},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true}},"description":"My Notes AI content generation settings."},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only the webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include the summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Whether to restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Who to automatically share the summary with. Valid values: `host` (Only the webinar host), `host_and_panelist_in_organization` (Only the webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (The webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."}},"description":"AI settings."}},"additionalProperties":false,"description":"Information about the user's previous settings. This only returns modified settings."}},"additionalProperties":false,"description":"Information about the user's previous settings."}},"additionalProperties":false}},"additionalProperties":false},"User.invitation_acceptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the invitation was sent to the user."},"object":{"required":["email","id","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false}},"additionalProperties":false},"Group.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that created the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group was created, in milliseconds.","format":"int64"},"object":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"name":{"type":"string","description":"The group name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"Group.settings_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the group's settings."},"operator":{"type":"string","description":"The email address of the user that updated the group's settings.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the group's settings."},"object":{"required":["id","settings"],"type":"object","properties":{"id":{"type":"string","description":"The updated group's ID."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean","description":"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."},"enable":{"type":"boolean","description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) setting enabled."},"numbers":{"maxItems":100,"type":"array","description":"The group's **Toll-free and Fee-based Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes)."},"country_code":{"type":"string","description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."},"country_name":{"type":"string","description":"The country name."},"display_number":{"type":"string","description":"The phone number's display number."},"number":{"type":"string","description":"The phone number."}}}}},"description":"The group's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) settings."},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"numbers":{"maxItems":100,"type":"array","description":"The group's **Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"country_code":{"type":"string","description":"The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"CN"},"country_name":{"type":"string","description":"The country name.","example":"China"},"display_number":{"maxLength":30,"type":"string","description":"The phone number's display number.","example":"+86 7777 777"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"7777 777"}}}}},"description":"The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings."},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean","description":"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.","example":true},"require_press_1_for_call_me":{"type":"string","description":"Require Call Me users to press 1 before being connected to the meeting. \n* `auto` - Automatically determine whether to require pressing 1 before connecting to the meeting. \n* `always` - Always require Call Me users to press 1 before connecting to the meeting. \n* `never` - Never require Call Me users to press 1 before connecting to the meeting.","example":"auto","enum":["auto","always","never"]},"call_out_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"The group's call out countries/regions settings."},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true}},"description":"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."},"personal_audio_conference":{"type":"boolean","description":"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.","example":true},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"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.","example":true},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"]}},"description":"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."}}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Whether alternative hosts receive an email when they are added or removed to a meeting."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether meeting participants and hosts receive a notification when the meeting is canceled."},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether the host is notified when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether the host is notified when participants join the meeting before them."},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available."},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available."},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or canceled."}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","description":"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_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether livestreaming is allowed."},"allow_participants_chat_with":{"type":"integer","description":"Whether participants can only chat with certain groups: \n* `1` — Participants cannot use chat. \n* `2` — Host and co-hosts only. \n* `3` — Participants can chat with other participants publicly. \n* `4` - Participants can chat with other participants publicly and privately. \n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4]},"allow_show_zoom_windows":{"type":"boolean","description":"Whether Zoom windows display screen share."},"allow_users_save_chats":{"type":"integer","description":"Whether participants can save meeting chats: \n* `1` — Participants cannot save meeting chats. \n* `2` — Participants can only save host and co-host meeting chats. \n* `3` — Participants can save all meeting chats.","enum":[1,2,3]},"annotation":{"type":"boolean","description":"Whether meeting participants can use annotation tools to add information to shared screens."},"auto_answer":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether all in-meeting chats are automatically saved."},"breakout_room":{"type":"boolean","description":"Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms)."},"breakout_room_schedule":{"type":"boolean","description":"Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher."},"chat":{"type":"boolean","description":"Whether meeting participants can send chat messages that are visible to all participants."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean","description":"Whether live transcription services are allowed to transcribe meetings."},"enable":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"save_caption":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"third_party_captioning_service":{"type":"boolean","description":"Whether the use of an API token to integrate with third-party closed captioning services is enabled."},"view_full_transcript":{"type":"boolean","description":"Whether participants can view full transcripts in the in-meeting side panel."}},"description":"Information about the group's closed captioning settings."},"co_host":{"type":"boolean","description":"Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host."},"custom_data_center_regions":{"type":"boolean","description":"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_service":{"type":"boolean","description":"Whether custom livestreaming is enabled."},"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"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_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"e2e_encryption":{"type":"boolean","description":"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_chime":{"type":"boolean","description":"Whether a chime plays when participants join or leave the meeting."},"far_end_camera_control":{"type":"boolean","description":"Whether other users are allowed to take control of the camera during a meeting."},"feedback":{"type":"boolean","description":"Whether users can provide feedback to Zoom at the end of the meeting."},"file_transfer":{"type":"boolean","description":"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_hd":{"type":"boolean","description":"Whether higher quality video is enabled for hosts and participants."},"join_from_desktop":{"type":"boolean","description":"Whether participants can join a meeting directly from their desktop browser."},"join_from_mobile":{"type":"boolean","description":"Whether participants can join a meeting directly from their mobile browser."},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","description":"A list of the user-defined supported languages.","items":{"type":"string"}},"enable_language_interpretation_by_default":{"type":"boolean","description":"Whether enable language interpretation by default.","example":true},"allow_participants_to_speak_in_listening_channel":{"type":"boolean","description":"Whether to allow participants to speak in listening channel.","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean","description":"Whether to allow up to 25 custom languages when scheduling meetings.","example":true},"enable":{"type":"boolean","description":"Whether hosts can assign participants as interpreters who can interpret one language into another in real-time."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string"},"enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]}},"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"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_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]}},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string"}}},"description":"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."},"live_streaming_facebook":{"type":"boolean","description":"Whether Facebook livestreaming is enabled."},"live_streaming_youtube":{"type":"boolean","description":"Whether YouTube livestreaming is enabled."},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean","description":"Whether the host can manually caption or let the host assign a participant to provide manual captioning."},"auto_generated_captions":{"type":"boolean","description":"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_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel."},"manual_captions":{"type":"boolean","description":"Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled."},"save_captions":{"type":"boolean","description":"Whether participants can [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n**Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions."},"third_party_captioning_service":{"type":"boolean","description":"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."}},"description":"Information about manual captioning settings."},"meeting_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Meetings"},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether the host can add polls before or during a meeting."}},"description":"Information about the account's meeting polling settings."},"meeting_reactions":{"type":"boolean","description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar."},"meeting_reactions_emojis":{"type":"string","description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `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) ","example":"all","enum":["all","selected"]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel."},"only_host_view_device_list":{"type":"boolean","description":"Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host."},"original_audio":{"type":"boolean","description":"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."},"polling":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether meeting participants can send private 1:1 chat message other meeting participants."},"record_play_own_voice":{"type":"boolean","description":"Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes."},"remote_control":{"type":"boolean","description":"During screen sharing, whether the person who is presenting can let others control the shared content."},"remote_support":{"type":"boolean","description":"Whether the meeting host can provide 1:1 remote support to another participant."},"request_permission_to_unmute":{"type":"boolean","description":"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_sharing":{"type":"boolean","description":"Whether hosts and participants can share their screen or content during meetings."},"sending_default_email_invites":{"type":"boolean","description":"Whether users can invite participants by email only by default."},"show_a_join_from_your_browser_link":{"type":"boolean","description":"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_list":{"type":"boolean","description":"Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users."},"show_meeting_control_toolbar":{"type":"boolean","description":"Whether to always display the meeting controls toolbar during a meeting."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"stereo_audio":{"type":"boolean","description":"Whether users can select stereo audio during a meeting."},"unchecked_data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to **not** opt in to: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","items":{"type":"string"},"enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]},"use_html_format_email":{"type":"boolean","description":"Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin."},"virtual_background":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean","description":"Whether users can upload custom Virtual Backgrounds."},"allow_videos":{"type":"boolean","description":"Whether users can upload videos for Virtual Backgrounds."},"enable":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"files":{"type":"array","description":"Information about the Virtual Background files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The file's ID."},"is_default":{"type":"boolean","description":"Whether the file is a default Virtual Background file."},"name":{"type":"string","description":"The file's name."},"size":{"type":"integer","description":"The file's size, in bytes."},"type":{"type":"string","description":"The file type."}}}}},"description":"Information about the Virtual Background settings."},"waiting_room":{"type":"boolean","description":"Whether participants cannot join a meeting until the host admits them from the waiting room."},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"type":"integer","description":"The webinar attendees' chat permissions: \n* `1` — Attendees cannot use chat. \n* `2` — Attendees can only chat with the host and panelists. \n* `3` — Attendees can chat with everyone.","enum":[1,2,3]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends."},"allow_panelists_chat_with":{"type":"integer","description":"The webinar panelists chat permissions: \n* `1` — Panelists can only chat with the host and panelists. \n* `2` — The panelists can chat with everyone.","enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether webinar panelists can send direct messages to other panelists."},"allow_users_save_chats":{"type":"integer","description":"Whether webinar attendees can save chats: \n* `0` — Attendees cannot save chats. \n* `1` — Attendees can only save host and panelist chats. \n* `2` — Attendees can save all chats.","enum":[0,1,2]},"default_attendees_chat_with":{"type":"integer","description":"By default, webinar attendees can chat with: \n* `1` — Host and all panelists. \n* `2` — Everyone.","enum":[1,2]},"enable":{"type":"boolean","description":"Whether in-webinar chat is enabled."}},"description":"Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings."},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"enable":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"live_streaming_reminder":{"type":"boolean","description":"Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol)."},"live_streaming_service":{"type":"array","description":"The available livestreaming services: \n* `facebook` \n* `workplace_by_facebook` \n* `youtube` \n* `custom_live_streaming_service`","items":{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]}}}},"webinar_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Meetings"},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."}}},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar."},"webinar_survey":{"type":"boolean","description":"Whether the host can present surveys to attendees once a webinar has ended."},"whiteboard":{"type":"boolean","description":"Whether participants can share a whiteboard that includes annotation tools."},"who_can_share_screen":{"type":"string","description":"The users who share their screen or content during meetings: \n* `host` — Only the host can share their screen. \n* `all` — Hosts and panelists can share their screen. Attendees **cannot** share their screen.","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","description":"The users who can start sharing screen when someone else in the meeting is sharing their screen: \n* `host` — Only the host can share the screen when someone else is sharing. \n* `all` — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing.","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can screen share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can screen share at a time\n.<br>\n`multiple`: Multiple participants can screen share simultaneously (dual monitors recommended).","example":"multiple","enum":["multiple","one"]},"workplace_by_facebook":{"type":"boolean","description":"Whether Workplace by Facebook is enabled."}}},"other_options":{"type":"object","properties":{"allow_users_contact_support_via_chat":{"type":"boolean","description":"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_snapshot":{"type":"boolean","description":"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_options":{"type":"object","properties":{"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\"","example":true}},"description":"Webinar registration options."}}},"profile":{"type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","description":"A list of the countries where the group's recorded content is stored.","items":{"type":"string"}},"value":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries)."}},"description":"Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings."}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Whether cloud recordings are accessible to account members."},"archive":{"type":"object","properties":{"enable":{"type":"boolean","description":"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)."},"settings":{"type":"object","properties":{"audio_file":{"type":"boolean","description":"Whether audio is included in the archive."},"cc_transcript_file":{"type":"boolean","description":"Whether closed captions are included in the archive."},"chat_file":{"type":"boolean","description":"Whether chat files are included in the archive."},"chat_with_sender_email":{"type":"boolean","description":"Whether user emails are included in the chat file."},"video_file":{"type":"boolean","description":"Whether video is included in the archive."}}},"type":{"type":"integer","description":"The type archiving: \n* `1` — Only archive meetings. \n* `2` — Only archive webinars. \n* `3` — Archive both meetings and webinars.","enum":[1,2,3]}},"description":"The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings."},"auto_recording":{"type":"boolean","description":"Whether meetings are automatically recorded when they begin."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meetings and webinars in the cloud."},"cloud_recording_download":{"type":"boolean","description":"Whether anyone with a link to the cloud recording can download the file."},"cloud_recording_download_host":{"type":"boolean","description":"Whether the host with a link to the cloud recording can download the file."},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording."},"host_delete_cloud_recording":{"type":"boolean","description":"Whether the host can delete cloud recordings. If `false`, only the admin can delete cloud recordings."},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether cloud recording access is only available for a specific range of IP addresses."},"ip_addresses_or_ranges":{"type":"string","description":"The IP addresses or ranges with access to the cloud recordings."}},"description":"Information about the cloud recording access from specific IP address ranges."},"local_recording":{"type":"boolean","description":"Whether hosts and participants can record meetings to a local file."},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"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_recording":{"type":"boolean","description":"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_file":{"type":"boolean","description":"Whether a single audio file is recorded for all participants."},"record_audio_file_each_participant":{"type":"boolean","description":"Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files."},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled."},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled."},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled."}},"description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings."},"record_gallery_view":{"type":"boolean","description":"Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen."},"record_speaker_view":{"type":"boolean","description":"Whether to record the active speaker when screen sharing is active."},"recording_audio_transcript":{"type":"boolean","description":"Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled."},"recording_highlight":{"type":"boolean","description":"Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled."},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","example":true},"create_smart_chapters":{"type":"boolean","description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","example":true},"create_next_steps":{"type":"boolean","description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","example":true}},"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights."},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen."},"save_chat_text":{"type":"boolean","description":"Whether chat messages are saved from meetings or webinars."},"save_close_caption":{"type":"boolean","description":"Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file."},"save_panelist_chat":{"type":"boolean","description":"Whether panelist chats are saved to the recording."},"save_poll_results":{"type":"boolean","description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar."},"show_timestamp":{"type":"boolean","description":"Whether a timestamp is included in the recording."}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Whether participants can join only the audio portion of meetings."},"embed_password_in_join_link":{"type":"boolean","description":"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_password":{"type":"boolean","description":"Whether passwords are required to join before the host in personal meetings."},"host_video":{"type":"boolean","description":"Whether host video defaults to on when they join meetings."},"join_before_host":{"type":"boolean","description":"Whether participants can join meetings before the host."},"mute_upon_entry":{"type":"boolean","description":"Whether all participants are automatically muted when they join meetings."},"participant_video":{"type":"boolean","description":"Whether participant video defaults to on when they join meetings."},"personal_meeting":{"type":"boolean","description":"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_protected":{"type":"boolean","description":"Whether new passwords are generated and sent for newly-scheduled or edited meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled."},"require_password_for_pmi_meetings":{"type":"string","description":"Whether participants are required to enter a password for PMI meetings: \n* `none` — Do not require a password for PMI meetings. \n* `all` — Require participants to enter password for all PMI-enabled meetings. \n* `jbh_only` — Only require a password for meetings where the **Join Before Host** setting is enabled.","enum":["none","all","jbh_only"]},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Whether a password is required for meetings which have already been scheduled."},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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_reminder":{"type":"boolean","description":"Whether desktop notification are sent for upcoming meetings."},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Whether PMI is enabled for all instant meetings."},"use_pmi_for_schedule_meetings":{"type":"boolean","description":"Whether a PMI is enabled for all scheduled meetings."},"always_display_zoom_meeting_as_topic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Always display \"Zoom Meeting\" as the meeting topic** setting is enabled."},"display_topic_for_scheduled_meetings":{"type":"boolean","description":"Whether \"Zoom Meeting\" displays as the topic for already-scheduled meetings."}},"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting."},"always_display_zoom_webinar_as_topic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Always show \"Zoom Webinar\" as the webinar topic** setting is enabled."},"display_topic_for_scheduled_webinars":{"type":"boolean","description":"Whether \"Zoom Webinar\" displays as the topic for already-scheduled meetings."}},"description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting."}}},"telephony":{"type":"object","properties":{"audio_conference_info":{"type":"string","description":"Information about the third-party audio configuration."},"telephony_regions":{"type":"object","properties":{"selection_values":{"type":"string","description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting."}},"description":"The telephony regions from which participants call in to or call from."},"third_party_audio":{"type":"boolean","description":"Whether users can join meetings using the existing third party audio configurations."}}},"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","description":"Whether all meetings are required to be secured with at least one security option. \n\nThis setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts."},"block_user_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars."},"block_user_domain_list":{"maxItems":20,"type":"array","description":"A list of blocked domains.","items":{"type":"string"}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Chat Etiquette Tool** is enabled."},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description."},"id":{"type":"string","description":"The policy ID."},"is_locked":{"type":"boolean","description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy."},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string"}},"name":{"type":"string","description":"The policy name."},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages."},"status":{"type":"string","description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"]},"trigger_action":{"type":"integer","description":"The policy's trigger action: \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2]}}}}},"description":"Information about the Chat Etiquette Tool."},"embed_password_in_join_link":{"type":"boolean","description":"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_type":{"type":"string","description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether end-to-end encryption is enabled for meetings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting."},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `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`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one letter character."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters."},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether the password must include uppercase and lowercase characters."},"length":{"type":"integer","description":"The password's minimum length."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."},"weak_enhance_detection":{"type":"boolean","description":"Whether users will be informed when the provided password is weak."}},"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether only authenticated users can join meetings from the web client."},"phone_password":{"type":"boolean","description":"Whether a password is required for participants joining by phone. \n\nIf 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_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether a password is required for meetings that have already been scheduled."},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether a password is required for webinars that have already been scheduled."},"waiting_room":{"type":"boolean","description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\nWhen 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_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2]},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1]},"whitelisted_domains_for_waiting_room":{"type":"string","description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (for example, `example.com,example2.com`)."}},"description":"Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings."},"webinar_password":{"type":"boolean","description":"Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar."}}},"chat":{"type":"object","properties":{"share_files":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to view, share, and forward files in chats and channels. When disabled, users can still take, share, and forward screenshots; record and forward voice and video messages; send and forward GIF images; and send and forward code snippets if those specific settings are enabled.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send files in chats and channels.","example":"account","enum":["disable","anyone","account","organization"]},"view_option":{"type":"string","description":"Allow users of this account to view files in chats and channels.","example":"anyone","enum":["anyone","account","organization"]},"restrictions":{"type":"object","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types","example":true},"file_type_restrictions":{"type":"array","description":"The restrictions of users can share files in chats and channels","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"file_type_restrictions_for_external":{"type":"array","description":"The restricted types for external users can share or view files in chats and channels","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"maximum_file_size":{"type":"boolean","description":"Whether to restrict file size","example":true},"file_size_restrictions":{"type":"integer","description":"Maximum file size","example":100,"enum":[50,100,200,300,400,500]},"file_size_restrictions_for_external":{"type":"integer","description":"Maximum file size for external users","example":100,"enum":[50,100,200,300,400,500]},"file_restrictions_apply_to":{"type":"string","description":"Apply restrictions to both sharing and viewing, or only apply to sharing","example":"sharing_and_viewing","enum":["sharing_and_viewing","sharing"]}},"description":"The restrictions of users can share files in chats and channels"}},"description":"Users can share files in chats and channels."},"chat_emojis":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"]}},"description":"Chat emojis."},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"allow_users_to_search_others_options":{"type":"string","description":"Allow users to search others, when selecting multiple items, separate them with commas: \n* ''-none. \n* '1' — In the same account. \n* '2' — Under the same master account, including all sub acounts. \n* '3' — Under the same organization.","example":"1,3"},"allow_users_to_add_contacts":{"type":"object","properties":{"enable":{"type":"boolean","description":"By disabling this setting, users will not be able to add contacts.","example":true},"selected_option":{"type":"integer","description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","description":"The domains or emails (internal or external). \n* 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. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","example":"123@test.com"}},"description":"Allow users to add contacts."},"allow_users_to_chat_with_others":{"type":"object","properties":{"enable":{"type":"boolean","description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","example":true},"selected_option":{"type":"integer","description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","description":"The domains or emails (internal or external). \n* 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. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","example":"123@test.com"}},"description":"Allow users to chat with others."},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","example":true,"default":false},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"id":{"type":"string","description":"The policy ID.","example":"aefwf23dsv;sdo-khuity8"},"status":{"type":"string","description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","example":"Activated","enum":["activated","deactivated"]}}}}},"description":"Information about the **Chat Etiquette** Tool."},"send_data_to_third_party_archiving_service":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true}},"description":"Send data to third-party archiving service."},"ai_sentence_completion":{"type":"boolean","description":"Sentence completion with AI Companion","example":false},"search_and_send_animated_gif_images":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to search GIF images from GIPHY when they compose messages.","example":true}},"description":"Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings."},"create_group_chat":{"type":"boolean","description":"Allow users to create group chats.","example":true},"allow_delete_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to delete messages","example":true}},"description":"When this setting is enabled, users can delete their own messages in Team Chat. If the user is the channel owner or admin and this setting is disabled, the user will also not be able to remove messages of other members in that channel even if other settings allow this. Time frame is configurable even when account setting is OFF and unlocked."},"download_file":{"type":"boolean","description":"Downloading files","example":true},"share_screen_in_chat":{"type":"boolean","description":"Share screen in chat","example":true},"ai_quick_schedule":{"type":"boolean","description":"Quick schedule with AI Companion","example":false},"survey_poll":{"type":"boolean","description":"Allow users to launch a poll in chats and channels","example":true},"allow_edit_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to edit messages","example":true}},"description":"When this setting is enabled, users can edit their own messages in Team Chat. Time frame is configurable even when account setting is OFF and unlocked."},"allow_huddles_from_channels":{"type":"boolean","description":"Allow huddles from channels","example":true},"shared_spaces":{"type":"boolean","description":"Allow users to create Shared Spaces","example":true},"translate_messages":{"type":"boolean","description":"Allow users to translate team chat messages. [Learn more].(https://support.zoom.us/hc/en-us/articles/12998089084685)","example":true},"ai_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_email_address":{"type":"object","properties":{"enable":{"type":"boolean","description":"Chat email address","example":true}},"description":"Allow users to create email addresses for chats and channels. Email sent to a created address will also be posted in respective chat or channel."},"ai_quick_reply":{"type":"boolean","description":"Quick reply with AI Companion","example":false},"ai_recommend":{"type":"boolean","description":"Chat Recommendation with Zoom AI Companion","example":false},"ai_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false}},"description":"Allow users to summarize chats, channels, and shared documents."},"read_receipts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable read receipts","example":false},"allow_users_opt_out":{"type":"boolean","description":"Allow users to opt out","example":false}},"description":"Indicate when messages have been seen by recipients, for chats and channels with less than 20 members."}},"description":"The account's chat settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history in the AI panel.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether users can use AI to compose or wordsmith email responses in Zoom Mail.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Office 365 documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Google Calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Gmail emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Google Drive documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether public web content can be used as a data source for AI.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether AI can consume the organization's custom dictionaries.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Allow participants to request AI Companion in a meeting.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Restrict AI Companion when an external user joins a meeting.","example":true},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"Restrict AI Companion when a restricted user joins a meeting.","example":true},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether restrictions on joining AI-enabled meetings are enabled.","example":true},"join_notify":{"type":"string","description":"Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: `out_of_compliance` (notify the user and allow them to remain), `notify_and_remove` (notify the user and remove them from the meeting).","example":"notify_and_remove","enum":["out_of_compliance","notify_and_remove"]},"apply_scope":{"type":"string","description":"Meeting scope to which the restriction applies. Valid values: `internal_only` (internal meetings only), `external_only` (external meetings only), `internal_and_external` (internal and external meetings).","example":"internal_and_external","enum":["internal_only","external_only","internal_and_external"]}},"description":"Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can ask questions in a meeting with AI.","example":true},"auto_enable":{"type":"boolean","description":"Automatically start meeting questions when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Participants allowed to ask meeting questions. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (organization participants from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can generate a meeting summary.","example":true},"auto_enable":{"type":"boolean","description":"Auto-start the meeting summary when the meeting starts.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing a meeting summary with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether the meeting summary email includes summary text. Valid values: `include_full_text_in_email` (include the summary text), `not_include_full_text_in_email` (do not include the summary text).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing meeting summaries with people outside the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Audience restricted from sharing meeting summaries. Valid values: `external_users` (users outside the organization), `all_users` (all users), `all_users_except_delegate` (all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Recipients for automatically shared meeting summaries. Valid values: `host` (only the meeting host), `alt_host` (meeting host, co-hosts, and alternative hosts), `organization` (meeting host and invitees in the organization), `all` (all meeting invitees, including external invitees), `host_and_panelist_in_organization` (meeting host and participants in the organization), `host_and_panelist_not_in_organization` (meeting host and all participants, including external participants), `host_and_speakers` (meeting host and speakers), `do_not_share` (do not share a summary).","example":"alt_host","enum":["host","alt_host","organization","all","host_and_panelist_in_organization","host_and_panelist_not_in_organization","host_and_speakers","do_not_share"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings.","example":true},"summary_template_id":{"type":"string","description":"ID of the default meeting summary template used to generate meeting summaries.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summaries automatically use the selected default language.","example":true},"language":{"type":"string","description":"Language that meeting summaries automatically use when the default-language setting is enabled. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en-US"}},"description":"Set the default language for meeting summaries."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether access to meeting summaries is restricted to specified IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.","example":true},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.","example":true},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.","example":true},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true},"auto_generate_summary":{"type":"boolean","description":"Whether My Notes automatically generates a summary when a note is completed.","example":true},"auto_send_summary_email":{"type":"boolean","description":"Whether My Notes automatically sends a summary email when a note summary is generated.","example":true}},"description":"My Notes AI content generation settings."},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Automatically share summary with. Valid values: `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."}},"description":"AI settings."}},"additionalProperties":false}},"additionalProperties":false,"description":"Information about the group's updated settings."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's settings were updated, in milliseconds.","format":"int64"},"old_object":{"required":["id","settings"],"type":"object","properties":{"id":{"type":"string","description":"The updated group's ID."},"settings":{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean","description":"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."},"enable":{"type":"boolean","description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) setting enabled."},"numbers":{"maxItems":100,"type":"array","description":"The group's **Toll-free and Fee-based Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes)."},"country_code":{"type":"string","description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."},"country_name":{"type":"string","description":"The country name."},"display_number":{"type":"string","description":"The phone number's display number."},"number":{"type":"string","description":"The phone number."}}}}},"description":"The group's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) settings."},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the group has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"numbers":{"maxItems":100,"type":"array","description":"The group's **Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"country_code":{"type":"string","description":"The phone number's [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"CN"},"country_name":{"type":"string","description":"The country name.","example":"China"},"display_number":{"maxLength":30,"type":"string","description":"The phone number's display number.","example":"+86 7777 777"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"7777 777"}}}}},"description":"The group's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings."},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean","description":"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.","example":true},"require_press_1_for_call_me":{"type":"string","description":"Require Call Me users to press 1 before being connected to the meeting. \n* `auto` - Automatically determine whether to require pressing 1 before connecting to the meeting. \n* `always` - Always require Call Me users to press 1 before connecting to the meeting. \n* `never` - Never require Call Me users to press 1 before connecting to the meeting.","example":"auto","enum":["auto","always","never"]},"call_out_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"The group's call out countries/regions settings."},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true}},"description":"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."},"personal_audio_conference":{"type":"boolean","description":"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.","example":true},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"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.","example":true},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"]}},"description":"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."}}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Whether alternative hosts receive an email when they are added or removed to a meeting."},"cancel_meeting_reminder":{"type":"boolean","description":"Whether meeting participants and hosts receive a notification when the meeting is canceled."},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether the host is notified when a cloud recording is available."},"jbh_reminder":{"type":"boolean","description":"Whether the host is notified when participants join the meeting before them."},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available."},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available."},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or canceled."}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","description":"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_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether livestreaming is allowed."},"allow_participants_chat_with":{"type":"integer","description":"Whether participants can only chat with certain groups: \n* `1` — Participants cannot use chat. \n* `2` — Host and co-hosts only. \n* `3` — Participants can chat with other participants publicly. \n* `4` - Participants can chat with other participants publicly and privately. \n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4]},"allow_show_zoom_windows":{"type":"boolean","description":"Whether Zoom windows display screen share."},"allow_users_save_chats":{"type":"integer","description":"Whether participants can save meeting chats: \n* `1` — Participants cannot save meeting chats. \n* `2` — Participants can only save host and co-host meeting chats. \n* `3` — Participants can save all meeting chats.","enum":[1,2,3]},"annotation":{"type":"boolean","description":"Whether meeting participants can use annotation tools to add information to shared screens."},"auto_answer":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether all in-meeting chats are automatically saved."},"breakout_room":{"type":"boolean","description":"Whether hosts can split meeting participants into [breakout rooms](https://support.zoom.us/hc/en-us/articles/206476093-Enabling-breakout-rooms)."},"breakout_room_schedule":{"type":"boolean","description":"Whether hosts can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher."},"chat":{"type":"boolean","description":"Whether meeting participants can send chat messages that are visible to all participants."},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean","description":"Whether live transcription services are allowed to transcribe meetings."},"enable":{"type":"boolean","description":"Whether the host can type closed captions or assign a participant/third party device to add closed captions."},"save_caption":{"type":"boolean","description":"Whether participants can save closed captions or transcripts."},"third_party_captioning_service":{"type":"boolean","description":"Whether the use of an API token to integrate with third-party closed captioning services is enabled."},"view_full_transcript":{"type":"boolean","description":"Whether participants can view full transcripts in the in-meeting side panel."}},"description":"Information about the group's closed captioning settings."},"co_host":{"type":"boolean","description":"Whether the host can add co-hosts. Co-hosts have the same in-meeting controls as the host."},"custom_data_center_regions":{"type":"boolean","description":"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_service":{"type":"boolean","description":"Whether custom livestreaming is enabled."},"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"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_guests":{"type":"boolean","description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled."},"e2e_encryption":{"type":"boolean","description":"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_chime":{"type":"boolean","description":"Whether a chime plays when participants join or leave the meeting."},"far_end_camera_control":{"type":"boolean","description":"Whether other users are allowed to take control of the camera during a meeting."},"feedback":{"type":"boolean","description":"Whether users can provide feedback to Zoom at the end of the meeting."},"file_transfer":{"type":"boolean","description":"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_hd":{"type":"boolean","description":"Whether higher quality video is enabled for hosts and participants."},"join_from_desktop":{"type":"boolean","description":"Whether participants can join a meeting directly from their desktop browser."},"join_from_mobile":{"type":"boolean","description":"Whether participants can join a meeting directly from their mobile browser."},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","description":"A list of the user-defined supported languages.","items":{"type":"string"}},"enable_language_interpretation_by_default":{"type":"boolean","description":"Whether enable language interpretation by default.","example":true},"allow_participants_to_speak_in_listening_channel":{"type":"boolean","description":"Whether to allow participants to speak in listening channel.","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean","description":"Whether to allow up to 25 custom languages when scheduling meetings.","example":true},"enable":{"type":"boolean","description":"Whether hosts can assign participants as interpreters who can interpret one language into another in real-time."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string"},"enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]}},"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"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_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler."},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]}},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string"}}},"description":"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."},"live_streaming_facebook":{"type":"boolean","description":"Whether Facebook livestreaming is enabled."},"live_streaming_youtube":{"type":"boolean","description":"Whether YouTube livestreaming is enabled."},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean","description":"Whether the host can manually caption or let the host assign a participant to provide manual captioning."},"auto_generated_captions":{"type":"boolean","description":"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_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel."},"manual_captions":{"type":"boolean","description":"Whether [manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription) is enabled."},"save_captions":{"type":"boolean","description":"Whether participants can [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n**Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions."},"third_party_captioning_service":{"type":"boolean","description":"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."}},"description":"Information about manual captioning settings."},"meeting_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Meetings"},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether the host can add polls before or during a meeting."}},"description":"Information about the account's meeting polling settings."},"meeting_reactions":{"type":"boolean","description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar."},"meeting_reactions_emojis":{"type":"string","description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `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) ","example":"all","enum":["all","selected"]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"Whether meeting participants can provide nonverbal feedback and express opinions by clicking on icons in the **Participants** panel."},"only_host_view_device_list":{"type":"boolean","description":"Whether to display the list of [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) available to the host."},"original_audio":{"type":"boolean","description":"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."},"polling":{"type":"boolean","description":"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_feedback":{"type":"boolean","description":"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_chat":{"type":"boolean","description":"Whether meeting participants can send private 1:1 chat message other meeting participants."},"record_play_own_voice":{"type":"boolean","description":"Whether to allow participants who join by telephone to record and play their own voice as entry and exit chimes."},"remote_control":{"type":"boolean","description":"During screen sharing, whether the person who is presenting can let others control the shared content."},"remote_support":{"type":"boolean","description":"Whether the meeting host can provide 1:1 remote support to another participant."},"request_permission_to_unmute":{"type":"boolean","description":"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_sharing":{"type":"boolean","description":"Whether hosts and participants can share their screen or content during meetings."},"sending_default_email_invites":{"type":"boolean","description":"Whether users can invite participants by email only by default."},"show_a_join_from_your_browser_link":{"type":"boolean","description":"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_list":{"type":"boolean","description":"Whether the available [H.323/SIP devices](https://support.zoom.us/hc/en-us/articles/201363273) are visible to users."},"show_meeting_control_toolbar":{"type":"boolean","description":"Whether to always display the meeting controls toolbar during a meeting."},"slide_control":{"type":"boolean","description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher."},"stereo_audio":{"type":"boolean","description":"Whether users can select stereo audio during a meeting."},"unchecked_data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to **not** opt in to: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","items":{"type":"string"},"enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]},"use_html_format_email":{"type":"boolean","description":"Whether HTML formatting is allowed for meeting invitations scheduled with the Outlook plugin."},"virtual_background":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean","description":"Whether users can upload custom Virtual Backgrounds."},"allow_videos":{"type":"boolean","description":"Whether users can upload videos for Virtual Backgrounds."},"enable":{"type":"boolean","description":"Whether the [**Virtual Background**](https://support.zoom.us/hc/en-us/articles/210707503-Changing-your-Virtual-Background-image) feature is enabled."},"files":{"type":"array","description":"Information about the Virtual Background files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The file's ID."},"is_default":{"type":"boolean","description":"Whether the file is a default Virtual Background file."},"name":{"type":"string","description":"The file's name."},"size":{"type":"integer","description":"The file's size, in bytes."},"type":{"type":"string","description":"The file type."}}}}},"description":"Information about the Virtual Background settings."},"waiting_room":{"type":"boolean","description":"Whether participants cannot join a meeting until the host admits them from the waiting room."},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"type":"integer","description":"The webinar attendees' chat permissions: \n* `1` — Attendees cannot use chat. \n* `2` — Attendees can only chat with the host and panelists. \n* `3` — Attendees can chat with everyone.","enum":[1,2,3]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether chat messages are automatically saved to a local file on the host's computer when the webinar ends."},"allow_panelists_chat_with":{"type":"integer","description":"The webinar panelists chat permissions: \n* `1` — Panelists can only chat with the host and panelists. \n* `2` — The panelists can chat with everyone.","enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether webinar panelists can send direct messages to other panelists."},"allow_users_save_chats":{"type":"integer","description":"Whether webinar attendees can save chats: \n* `0` — Attendees cannot save chats. \n* `1` — Attendees can only save host and panelist chats. \n* `2` — Attendees can save all chats.","enum":[0,1,2]},"default_attendees_chat_with":{"type":"integer","description":"By default, webinar attendees can chat with: \n* `1` — Host and all panelists. \n* `2` — Everyone.","enum":[1,2]},"enable":{"type":"boolean","description":"Whether in-webinar chat is enabled."}},"description":"Information about the group's [in-webinar chat](https://support.zoom.us/hc/en-us/articles/115004809306) settings."},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream."},"enable":{"type":"boolean","description":"Whether webinar livestreaming is enabled."},"live_streaming_reminder":{"type":"boolean","description":"Whether users are notified to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol)."},"live_streaming_service":{"type":"array","description":"The available livestreaming services: \n* `facebook` \n* `workplace_by_facebook` \n* `youtube` \n* `custom_live_streaming_service`","items":{"type":"string","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]}}}},"webinar_polling":{"type":"object","properties":{"advanced_polls":{"type":"boolean","description":"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."},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether alternative hosts can add or edit polls and quizzes."},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Meetings"},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether the host can add polls before or during a webinar."}}},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar."},"webinar_survey":{"type":"boolean","description":"Whether the host can present surveys to attendees once a webinar has ended."},"whiteboard":{"type":"boolean","description":"Whether participants can share a whiteboard that includes annotation tools."},"who_can_share_screen":{"type":"string","description":"The users who share their screen or content during meetings: \n* `host` — Only the host can share their screen. \n* `all` — Hosts and panelists can share their screen. Attendees **cannot** share their screen.","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","description":"The users who can start sharing screen when someone else in the meeting is sharing their screen: \n* `host` — Only the host can share the screen when someone else is sharing. \n* `all` — Hosts and panelists can share their screen when someone else is sharing. Attendees **cannot** share their screen when someone else is sharing.","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can screen share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can screen share at a time\n.<br>\n`multiple`: Multiple participants can screen share simultaneously (dual monitors recommended).","example":"multiple","enum":["multiple","one"]},"workplace_by_facebook":{"type":"boolean","description":"Whether Workplace by Facebook is enabled."}}},"other_options":{"type":"object","properties":{"allow_users_contact_support_via_chat":{"type":"boolean","description":"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_snapshot":{"type":"boolean","description":"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_options":{"type":"object","properties":{"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\"","example":true}},"description":"Webinar registration options."}}},"profile":{"type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","description":"A list of the countries where the group's recorded content is stored.","items":{"type":"string"}},"value":{"type":"string","description":"The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries)."}},"description":"Information about the group's [**Communications Content Storage**](https://support.zoom.us/hc/en-us/articles/360050781131) settings."}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Whether cloud recordings are accessible to account members."},"archive":{"type":"object","properties":{"enable":{"type":"boolean","description":"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)."},"settings":{"type":"object","properties":{"audio_file":{"type":"boolean","description":"Whether audio is included in the archive."},"cc_transcript_file":{"type":"boolean","description":"Whether closed captions are included in the archive."},"chat_file":{"type":"boolean","description":"Whether chat files are included in the archive."},"chat_with_sender_email":{"type":"boolean","description":"Whether user emails are included in the chat file."},"video_file":{"type":"boolean","description":"Whether video is included in the archive."}}},"type":{"type":"integer","description":"The type archiving: \n* `1` — Only archive meetings. \n* `2` — Only archive webinars. \n* `3` — Archive both meetings and webinars.","enum":[1,2,3]}},"description":"The group's [Meeting and Webinar Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings."},"auto_recording":{"type":"boolean","description":"Whether meetings are automatically recorded when they begin."},"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save the meetings and webinars in the cloud."},"cloud_recording_download":{"type":"boolean","description":"Whether anyone with a link to the cloud recording can download the file."},"cloud_recording_download_host":{"type":"boolean","description":"Whether the host with a link to the cloud recording can download the file."},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording."},"host_delete_cloud_recording":{"type":"boolean","description":"Whether the host can delete cloud recordings. If `false`, only the admin can delete cloud recordings."},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether cloud recording access is only available for a specific range of IP addresses."},"ip_addresses_or_ranges":{"type":"string","description":"The IP addresses or ranges with access to the cloud recordings."}},"description":"Information about the cloud recording access from specific IP address ranges."},"local_recording":{"type":"boolean","description":"Whether hosts and participants can record meetings to a local file."},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"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_recording":{"type":"boolean","description":"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_file":{"type":"boolean","description":"Whether a single audio file is recorded for all participants."},"record_audio_file_each_participant":{"type":"boolean","description":"Whether a separate audio file is recorded of each participant. This only supports the first 200 participant speakers' audio files."},"record_files_separately":{"type":"object","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled."},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled."},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled."}},"description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings."},"record_gallery_view":{"type":"boolean","description":"Whether the active speaker displays in the top right corner of a shared screen when someone is sharing their screen."},"record_speaker_view":{"type":"boolean","description":"Whether to record the active speaker when screen sharing is active."},"recording_audio_transcript":{"type":"boolean","description":"Whether the automatic transcription of a meeting or webinar's audio for cloud recordings is enabled."},"recording_highlight":{"type":"boolean","description":"Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled."},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","example":true},"create_smart_chapters":{"type":"boolean","description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","example":true},"create_next_steps":{"type":"boolean","description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","example":true}},"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights."},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen."},"save_chat_text":{"type":"boolean","description":"Whether chat messages are saved from meetings or webinars."},"save_close_caption":{"type":"boolean","description":"Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file."},"save_panelist_chat":{"type":"boolean","description":"Whether panelist chats are saved to the recording."},"save_poll_results":{"type":"boolean","description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar."},"show_timestamp":{"type":"boolean","description":"Whether a timestamp is included in the recording."}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Whether participants can join only the audio portion of meetings."},"embed_password_in_join_link":{"type":"boolean","description":"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_password":{"type":"boolean","description":"Whether passwords are required to join before the host in personal meetings."},"host_video":{"type":"boolean","description":"Whether host video defaults to on when they join meetings."},"join_before_host":{"type":"boolean","description":"Whether participants can join meetings before the host."},"mute_upon_entry":{"type":"boolean","description":"Whether all participants are automatically muted when they join meetings."},"participant_video":{"type":"boolean","description":"Whether participant video defaults to on when they join meetings."},"personal_meeting":{"type":"boolean","description":"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_protected":{"type":"boolean","description":"Whether new passwords are generated and sent for newly-scheduled or edited meetings."},"require_password_for_instant_meetings":{"type":"boolean","description":"Whether passwords are required for instant meetings. If you use a PMI for instant meetings, this is disabled."},"require_password_for_pmi_meetings":{"type":"string","description":"Whether participants are required to enter a password for PMI meetings: \n* `none` — Do not require a password for PMI meetings. \n* `all` — Require participants to enter password for all PMI-enabled meetings. \n* `jbh_only` — Only require a password for meetings where the **Join Before Host** setting is enabled.","enum":["none","all","jbh_only"]},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Whether a password is required for meetings which have already been scheduled."},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"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_reminder":{"type":"boolean","description":"Whether desktop notification are sent for upcoming meetings."},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Whether PMI is enabled for all instant meetings."},"use_pmi_for_schedule_meetings":{"type":"boolean","description":"Whether a PMI is enabled for all scheduled meetings."},"always_display_zoom_meeting_as_topic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Always display \"Zoom Meeting\" as the meeting topic** setting is enabled."},"display_topic_for_scheduled_meetings":{"type":"boolean","description":"Whether \"Zoom Meeting\" displays as the topic for already-scheduled meetings."}},"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting."},"always_display_zoom_webinar_as_topic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Always show \"Zoom Webinar\" as the webinar topic** setting is enabled."},"display_topic_for_scheduled_webinars":{"type":"boolean","description":"Whether \"Zoom Webinar\" displays as the topic for already-scheduled meetings."}},"description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting."}}},"telephony":{"type":"object","properties":{"audio_conference_info":{"type":"string","description":"Information about the third-party audio configuration."},"telephony_regions":{"type":"object","properties":{"selection_values":{"type":"string","description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting."}},"description":"The telephony regions from which participants call in to or call from."},"third_party_audio":{"type":"boolean","description":"Whether users can join meetings using the existing third party audio configurations."}}},"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","description":"Whether all meetings are required to be secured with at least one security option. \n\nThis setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts."},"block_user_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars."},"block_user_domain_list":{"maxItems":20,"type":"array","description":"A list of blocked domains.","items":{"type":"string"}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the **Chat Etiquette Tool** is enabled."},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description."},"id":{"type":"string","description":"The policy ID."},"is_locked":{"type":"boolean","description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy."},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string"}},"name":{"type":"string","description":"The policy name."},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages."},"status":{"type":"string","description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"]},"trigger_action":{"type":"integer","description":"The policy's trigger action: \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2]}}}}},"description":"Information about the Chat Etiquette Tool."},"embed_password_in_join_link":{"type":"boolean","description":"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_type":{"type":"string","description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether end-to-end encryption is enabled for meetings."},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting."},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `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`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"Whether the password must contain at least one letter character."},"have_number":{"type":"boolean","description":"Whether the password must contain at least one numeric character."},"have_special_character":{"type":"boolean","description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters."},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether the password must include uppercase and lowercase characters."},"length":{"type":"integer","description":"The password's minimum length."},"only_allow_numeric":{"type":"boolean","description":"Whether the password must contain **only** numeric characters."},"weak_enhance_detection":{"type":"boolean","description":"Whether users will be informed when the provided password is weak."}},"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether only authenticated users can join meetings from the web client."},"phone_password":{"type":"boolean","description":"Whether a password is required for participants joining by phone. \n\nIf 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_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected."},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether a password is required for meetings that have already been scheduled."},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether a password is required for webinars that have already been scheduled."},"waiting_room":{"type":"boolean","description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\nWhen 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_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2]},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1]},"whitelisted_domains_for_waiting_room":{"type":"string","description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (for example, `example.com,example2.com`)."}},"description":"Information about the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/4470816222093-Managing-Waiting-Rooms) feature settings."},"webinar_password":{"type":"boolean","description":"Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar."}}},"chat":{"type":"object","properties":{"share_files":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to view, share, and forward files in chats and channels. When disabled, users can still take, share, and forward screenshots; record and forward voice and video messages; send and forward GIF images; and send and forward code snippets if those specific settings are enabled.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send files in chats and channels.","example":"account","enum":["disable","anyone","account","organization"]},"view_option":{"type":"string","description":"Allow users of this account to view files in chats and channels.","example":"anyone","enum":["anyone","account","organization"]},"restrictions":{"type":"object","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types","example":true},"file_type_restrictions":{"type":"array","description":"The restrictions of users can share files in chats and channels","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"file_type_restrictions_for_external":{"type":"array","description":"The restricted types for external users can share or view files in chats and channels","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"maximum_file_size":{"type":"boolean","description":"Whether to restrict file size","example":true},"file_size_restrictions":{"type":"integer","description":"Maximum file size","example":100,"enum":[50,100,200,300,400,500]},"file_size_restrictions_for_external":{"type":"integer","description":"Maximum file size for external users","example":100,"enum":[50,100,200,300,400,500]},"file_restrictions_apply_to":{"type":"string","description":"Apply restrictions to both sharing and viewing, or only apply to sharing","example":"sharing_and_viewing","enum":["sharing_and_viewing","sharing"]}},"description":"The restrictions of users can share files in chats and channels"}},"description":"Users can share files in chats and channels."},"chat_emojis":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"]}},"description":"Chat emojis."},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"allow_users_to_search_others_options":{"type":"string","description":"Allow users to search others, when selecting multiple items, separate them with commas: \n* ''-none. \n* '1' — In the same account. \n* '2' — Under the same master account, including all sub acounts. \n* '3' — Under the same organization.","example":"1,3"},"allow_users_to_add_contacts":{"type":"object","properties":{"enable":{"type":"boolean","description":"By disabling this setting, users will not be able to add contacts.","example":true},"selected_option":{"type":"integer","description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","description":"The domains or emails (internal or external). \n* 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. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","example":"123@test.com"}},"description":"Allow users to add contacts."},"allow_users_to_chat_with_others":{"type":"object","properties":{"enable":{"type":"boolean","description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","example":true},"selected_option":{"type":"integer","description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","description":"The domains or emails (internal or external). \n* 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. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","example":"123@test.com"}},"description":"Allow users to chat with others."},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","example":true,"default":false},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"id":{"type":"string","description":"The policy ID.","example":"aefwf23dsv;sdo-khuity8"},"status":{"type":"string","description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","example":"Activated","enum":["activated","deactivated"]}}}}},"description":"Information about the **Chat Etiquette** Tool."},"send_data_to_third_party_archiving_service":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true}},"description":"Send data to third-party archiving service."},"create_group_chat":{"type":"boolean","description":"Allow users to create group chats.","example":true}},"description":"The account's chat settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history in the AI panel.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether users can use AI to compose or wordsmith email responses in Zoom Mail.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Office 365 documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Google Calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Gmail emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Google Drive documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether public web content can be used as a data source for AI.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether AI can consume the organization's custom dictionaries.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.","example":true},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Allow participants to request AI Companion in a meeting.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Restrict AI Companion when an external user joins a meeting.","example":true},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"Restrict AI Companion when a restricted user joins a meeting.","example":true},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether restrictions on joining AI-enabled meetings are enabled.","example":true},"join_notify":{"type":"string","description":"Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: `out_of_compliance` (notify the user and allow them to remain), `notify_and_remove` (notify the user and remove them from the meeting).","example":"notify_and_remove","enum":["out_of_compliance","notify_and_remove"]},"apply_scope":{"type":"string","description":"Meeting scope to which the restriction applies. Valid values: `internal_only` (internal meetings only), `external_only` (external meetings only), `internal_and_external` (internal and external meetings).","example":"internal_and_external","enum":["internal_only","external_only","internal_and_external"]}},"description":"Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can ask questions in a meeting with AI.","example":true},"auto_enable":{"type":"boolean","description":"Automatically start meeting questions when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Participants allowed to ask meeting questions. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (organization participants from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether hosts can generate a meeting summary.","example":true},"auto_enable":{"type":"boolean","description":"Auto-start the meeting summary when the meeting starts.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing a meeting summary with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether the meeting summary email includes summary text. Valid values: `include_full_text_in_email` (include the summary text), `not_include_full_text_in_email` (do not include the summary text).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing meeting summaries with people outside the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Audience restricted from sharing meeting summaries. Valid values: `external_users` (users outside the organization), `all_users` (all users), `all_users_except_delegate` (all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Recipients for automatically shared meeting summaries. Valid values: `host` (only the meeting host), `alt_host` (meeting host, co-hosts, and alternative hosts), `organization` (meeting host and invitees in the organization), `all` (all meeting invitees, including external invitees), `host_and_panelist_in_organization` (meeting host and participants in the organization), `host_and_panelist_not_in_organization` (meeting host and all participants, including external participants), `host_and_speakers` (meeting host and speakers), `do_not_share` (do not share a summary).","example":"alt_host","enum":["host","alt_host","organization","all","host_and_panelist_in_organization","host_and_panelist_not_in_organization","host_and_speakers","do_not_share"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings.","example":true},"summary_template_id":{"type":"string","description":"ID of the default meeting summary template used to generate meeting summaries.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summaries automatically use the selected default language.","example":true},"language":{"type":"string","description":"Language that meeting summaries automatically use when the default-language setting is enabled. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en-US"}},"description":"Set the default language for meeting summaries."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether access to meeting summaries is restricted to specified IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.","example":true},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.","example":true},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.","example":true},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true},"auto_generate_summary":{"type":"boolean","description":"Whether My Notes automatically generates a summary when a note is completed.","example":true},"auto_send_summary_email":{"type":"boolean","description":"Whether My Notes automatically sends a summary email when a note summary is generated.","example":true}},"description":"My Notes AI content generation settings."},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Automatically share summary with. Valid values: `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."}},"description":"AI settings."}},"additionalProperties":false,"description":"Information about the group's updated settings. This only returns modified settings."}},"additionalProperties":false,"description":"Information about the group's previous settings."}},"additionalProperties":false}},"additionalProperties":false},"User.disassociatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the user was disassociated."},"operator":{"type":"string","description":"The email address of the user that disassociated the user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that disassociated the user."},"object":{"required":["email","first_name","id","last_name","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the disassociated user."}},"additionalProperties":false}},"additionalProperties":false},"Group.updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that updated the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group was updated, in milliseconds.","format":"int64"},"object":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"name":{"type":"string","description":"The group name."}},"additionalProperties":false},"old_object":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The updated group's ID."},"name":{"type":"string","description":"The modified field its original value."}},"additionalProperties":false,"description":"Information about the group's previous settings."}},"additionalProperties":false}},"additionalProperties":false},"User.presence_status_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Webhook event name. For example, 'user.presence_status_updated'."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred, in Unix epoch milliseconds. For example, 1712145600000.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The unique account ID of the user's account owner. For example, 'Efg123AbCd'."},"object":{"required":["date_time","email","id","presence_status"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the user's presence status was updated, in RFC 3339 format. For example, '2026-04-03T15:19:00Z'.","format":"date-time"},"email":{"type":"string","description":"The user's email address. For example, 'user@example.com'.","format":"email"},"id":{"type":"string","description":"The user's unique identifier. For example, 'aBc123XyZ'."},"presence_status":{"type":"string","description":"The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488): \n* `Available` — Online. \n* `Away` — Away. \n* `Do_Not_Disturb` — Do not disturb. \n* `In_Meeting` — In a Zoom meeting. \n* `Presenting` — Sharing their screen in a Zoom meeting. \n* `On_Phone_Call` — On a Zoom Phone call. \n* `In_Calendar_Event` — In a calendar event. \n* `Offline` - Signed out or inactive. \n* `Mobile_signed_in` — Desktop device is offline, but mobile device is signed in.","enum":["Available","Away","Do_Not_Disturb","In_Meeting","Presenting","On_Phone_Call","In_Calendar_Event","Offline","Busy","Mobile_signed_in"]},"app":{"required":["presence_status","type"],"type":"object","properties":{"type":{"type":"string","description":"The app type that reported the presence status: \n* `desktop` — Desktop client. \n* `mobile` - Mobile device. \n* `pad` - Tablet device. \n* `pzr` — Personal Zoom Room.","enum":["desktop","mobile","pad","pzr"]},"presence_status":{"type":"string","description":"The user's [presence status](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488) on this app: \n* `Available` — Online. \n* `Away` — Away. \n* `Do_Not_Disturb` — Do not disturb. \n* `In_Meeting` — In a Zoom meeting. \n* `Presenting` — Sharing their screen in a Zoom meeting. \n* `On_Phone_Call` — On a Zoom Phone call. \n* `In_Calendar_Event` — In a calendar event. \n* `Offline` - Signed out or inactive.","enum":["Available","Away","Do_Not_Disturb","In_Meeting","Presenting","On_Phone_Call","In_Calendar_Event","Offline","Busy"]}},"additionalProperties":false,"description":"Information about the app that triggered the event. "}},"additionalProperties":false,"description":"Information about the user whose presence status changed."}},"additionalProperties":false}},"additionalProperties":false},"User.activatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user's account owner."},"operator":{"type":"string","description":"The email address of the user that activated the user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that activated the user."},"object":{"required":["email","first_name","id","last_name","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the activated user."}},"additionalProperties":false}},"additionalProperties":false},"User.signed_inEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the user signed in."},"object":{"required":["client_type","date_time","email","id","login_type","version"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"client_type":{"type":"string","description":"The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): \n* `browser` — Browser. \n* `mac` — MacOS. \n* `win` — Windows. \n* `iphone` — iPhone. \n* `android` — Android. \n* `ipad` — iPad. \n* `chromeos` — Chrome OS. \n* `linux` — Linux.","enum":["browser","mac","win","iphone","android","ipad","chromeos","linux"]},"date_time":{"type":"string","description":"The date and time at which the user signed in.","format":"date-time"},"email":{"type":"string","description":"The user's email address.","format":"email"},"version":{"type":"string","description":"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."},"login_type":{"type":"integer","description":"The method the user logged in with: \n* `0` — Facebook. \n* `1` — Google. \n* `100` — Zoom. \n* `101` — Single Sign-On (SSO).","enum":[0,1,100,101]}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false}},"additionalProperties":false},"User.signed_outEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the account from which the user signed out."},"object":{"required":["client_type","date_time","email","id","login_type","version"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"client_type":{"type":"string","description":"The user's client [type](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060407): \n* `browser` — Browser. \n* `mac` — MacOS. \n* `win` — Windows. \n* `iphone` — iPhone. \n* `android` — Android. \n* `ipad` — iPad. \n* `chromeos` — Chrome OS. \n* `linux` — Linux.","enum":["browser","mac","win","iphone","android","ipad","chromeos","linux"]},"date_time":{"type":"string","description":"The date and time at which the user signed out.","format":"date-time"},"email":{"type":"string","description":"The user's email address.","format":"email"},"version":{"type":"string","description":"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."},"login_type":{"type":"integer","description":"The method the user logged in with: \n* `0` — Facebook. \n* `1` — Google. \n* `100` — Zoom. \n* `101` — Single Sign-On (SSO).","enum":[0,1,100,101]}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false}},"additionalProperties":false},"User.personal_notes_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user's account owner."},"object":{"required":["date_time","email","id","personal_notes"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time at which the user's personal note was updated.","format":"date-time"},"email":{"type":"string","description":"The user's email address.","format":"email"},"id":{"type":"string","description":"The user's ID."},"personal_notes":{"type":"string","description":"The updated [personal note](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066608)."}},"additionalProperties":false,"description":"Information about the user."},"old_object":{"required":["personal_notes"],"type":"object","properties":{"personal_notes":{"type":"string","description":"The previous personal note entry."}},"additionalProperties":false,"description":"Information about the user's previous personal note."}},"additionalProperties":false}},"additionalProperties":false},"Group.member_addedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that added members to the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that added members to the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group's members were added, in milliseconds.","format":"int64"},"object":{"required":["id","members"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"members":{"type":"array","description":"Information about the members added to the group.","items":{"type":"object","properties":{"id":{"type":"string","description":"The member's user ID."},"email":{"type":"string","description":"The member's email address.","format":"email"}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"User.updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the user."},"operator":{"type":"string","description":"The email address of the user that updated the user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the user."},"operation":{"type":"string","description":"This field only returns for the following operations: \n* `change_password` \n* `sign_out_from_all_devices`","enum":["change_password","sign_out_from_all_devices"]},"object":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"display_name":{"type":"string","description":"The user's display name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]},"phone_number":{"type":"string","description":"The user's phone number."},"phone_country":{"type":"string","description":"**Note:** This field is **deprecated**. Use the `phone_numbers` field. \n\n The user's phone number country.","deprecated":true},"company":{"type":"string","description":"The user's company."},"pmi":{"type":"integer","description":"The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271).","format":"int64"},"use_pmi":{"type":"boolean","description":"Whether a PMI will be used instead of an auto-generated meeting ID."},"timezone":{"type":"string","description":"The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api)."},"pic_url":{"type":"string","description":"The user's profile picture URL."},"vanity_name":{"type":"string","description":"The user's personal meeting room name."},"host_key":{"maxLength":10,"minLength":0,"type":"string","description":"The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063)."},"role":{"type":"string","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983)."},"dept":{"type":"string","description":"The user's department."},"language":{"type":"string","description":"The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475)."},"settings":{"type":"object","properties":{"feature":{"type":"object","properties":{"large_meeting_capacity":{"type":"integer","description":"The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis."},"webinar":{"type":"boolean","description":"Whether the Webinar plan is enabled for the user."},"webinar_capacity":{"type":"integer","description":"The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis."}},"description":"The user's updated profile features."},"meeting_capacity":{"type":"integer","description":"The user's meeting capacity."},"large_meeting":{"type":"string","description":"Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user."}},"additionalProperties":false,"description":"The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting)."},"custom_attributes":{"type":"array","description":"Information about the user's custom attributes. This field only returns if users are assigned custom attributes.","items":{"required":["key","name","value"],"type":"object","properties":{"key":{"type":"string","description":"The custom attribute's unique ID."},"name":{"type":"string","description":"The custom attribute's name."},"value":{"type":"integer","description":"The custom attribute's value."}},"additionalProperties":false}},"primary_group_id":{"type":"string","description":"The user's primary group id, the field returns values if a user's primary group is changed."}},"additionalProperties":false,"description":"Information about the updated user."},"time_stamp":{"type":"integer","description":"The user's update timestamp, in milliseconds.","format":"int64"},"old_object":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"display_name":{"type":"string","description":"The user's display name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]},"phone_number":{"type":"string","description":"The user's phone number."},"phone_country":{"type":"string","description":"**Note:** This field is **deprecated**. Use the `phone_numbers` field. \n\n The user's phone number country.","deprecated":true},"company":{"type":"string","description":"The user's company."},"pmi":{"type":"integer","description":"The user's [Personal Meeting ID (PMI)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066271).","format":"int64"},"use_pmi":{"type":"boolean","description":"Whether a PMI will be used instead of an auto-generated meeting ID."},"timezone":{"type":"string","description":"The user's [timezone](/docs/api/using-zoom-apis/#time-in-zoom-api)."},"pic_url":{"type":"string","description":"The user's profile picture URL."},"vanity_name":{"type":"string","description":"The user's personal meeting room name."},"host_key":{"maxLength":10,"minLength":0,"type":"string","description":"The user's [host key](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067063)."},"role":{"type":"string","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983)."},"dept":{"type":"string","description":"The user's department."},"language":{"type":"string","description":"The user's [display language](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062475)."},"settings":{"type":"object","properties":{"feature":{"type":"object","properties":{"large_meeting_capacity":{"type":"integer","description":"The number of [large meeting participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis."},"webinar":{"type":"boolean","description":"Whether the Webinar plan is enabled for the user."},"webinar_capacity":{"type":"integer","description":"The number of [webinar participants](/docs/api/references/billing-plans/#large-meeting-plans) allowed on a per-month or yearly basis."}},"description":"The user's updated profile features."},"meeting_capacity":{"type":"integer","description":"The user's meeting capacity."},"large_meeting":{"type":"string","description":"Whether a [large meeting plan](/docs/api/references/billing-plans/#large-meeting-plans) is enabled for the user."}},"additionalProperties":false,"description":"The [user's profile](https://zoom.us/profile) settings. These settings are different from [user settings](https://zoom.us/profile/setting)."},"custom_attributes":{"type":"array","description":"Information about the user's custom attributes. This field only returns if users are assigned custom attributes.","items":{"required":["key","name","value"],"type":"object","properties":{"key":{"type":"string","description":"The custom attribute's unique ID."},"name":{"type":"string","description":"The custom attribute's name."},"value":{"type":"integer","description":"The custom attribute's value."}},"additionalProperties":false}},"primary_group_id":{"type":"string","description":"The user's primary group id, the field returns values if a user's primary group is changed."}},"additionalProperties":false,"description":"Information about the user's previous value."}},"additionalProperties":false}},"additionalProperties":false},"Group.deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The group's account ID."},"operator":{"type":"string","description":"The email address of the user that deleted the group.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the group."},"time_stamp":{"type":"integer","description":"A timestamp that indicates when the group was deleted, in milliseconds.","format":"int64"},"object":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The group ID."},"name":{"type":"string","description":"The group name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"User.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","creation_type","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the user."},"operator":{"type":"string","description":"The email address of the user who created the new user.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the new user."},"creation_type":{"type":"string","description":"The method used to create the new user: \n* `create` \n* `ssoCreate` \n* `autoCreate` \n* `custCreate`","enum":["create","ssoCreate","autoCreate","custCreate"]},"object":{"required":["email","id","type"],"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"first_name":{"type":"string","description":"The user's first name."},"last_name":{"type":"string","description":"The user's last name."},"display_name":{"type":"string","description":"The user's display name."},"email":{"type":"string","description":"The user's email address.","format":"email"},"type":{"type":"integer","description":"The type of user: \n* `1` — Basic. \n* `2` — Licensed.","enum":[1,2]}},"additionalProperties":false,"description":"Information about the created user."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Groups"},{"name":"Users"}],"servers":[{"url":"https://{your-endpoint-url}"}]}