Zoom Public API Documentation

Update a group's settings

PATCH {{baseUrl}}/groups/:groupId/settings?option=recording_authentication

Update settings for a group. Note:The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality Prerequisite: Pro, Business, or Education account

Scopes: group:write:admin

Rate Limit Label: MEDIUM

Body PARAM

Key	Datatype	Required	Description
option	string		Optional query parameters. * `meeting_authentication` - [Meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars). * `recording_authentication` - [Recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings). * `meeting_security` - Meeting security settings.

HEADERS

Key	Datatype	Required	Description
Content-Type	string
Accept	string

RESPONSES

status OK

{}

Curl

curl -X PATCH 'https://api.zoom.us/v2/groups/:groupId/settings?option=recording_authentication?option=recording_authentication' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"audio_conferencing":{"toll_free_and_fee_based_toll_call":{"allow_webinar_attendees_dial":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","numbers":[{"code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","country_name":"\u003cstring\u003e","display_number":"\u003cstring\u003e","number":"\u003cstring\u003e"}]}},"email_notification":{"alternative_host_reminder":"\u003cboolean\u003e","cancel_meeting_reminder":"\u003cboolean\u003e","cloud_recording_available_reminder":"\u003cboolean\u003e","jbh_reminder":"\u003cboolean\u003e","recording_available_reminder_alternative_hosts":"\u003cboolean\u003e","recording_available_reminder_schedulers":"\u003cboolean\u003e","schedule_for_reminder":"\u003cboolean\u003e"},"in_meeting":{"alert_guest_join":"\u003cboolean\u003e","allow_users_to_delete_messages_in_meeting_chat":"\u003cboolean\u003e","allow_live_streaming":"\u003cboolean\u003e","allow_participants_chat_with":2,"allow_show_zoom_windows":"\u003cboolean\u003e","allow_users_save_chats":2,"annotation":"\u003cboolean\u003e","attendee_on_hold":false,"auto_answer":"\u003cboolean\u003e","auto_saving_chat":"\u003cboolean\u003e","breakout_room":"\u003cboolean\u003e","breakout_room_schedule":"\u003cboolean\u003e","chat":"\u003cboolean\u003e","meeting_question_answer":"\u003cboolean\u003e","closed_caption":"\u003cboolean\u003e","closed_captioning":{"auto_transcribing":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","save_caption":"\u003cboolean\u003e","third_party_captioning_service":"\u003cboolean\u003e","view_full_transcript":"\u003cboolean\u003e"},"co_host":"\u003cboolean\u003e","custom_data_center_regions":"\u003cboolean\u003e","custom_live_streaming_service":"\u003cboolean\u003e","custom_service_instructions":"\u003cstring\u003e","data_center_regions":["IN"],"disable_screen_sharing_for_host_meetings":"\u003cboolean\u003e","disable_screen_sharing_for_in_meeting_guests":"\u003cboolean\u003e","e2e_encryption":"\u003cboolean\u003e","entry_exit_chime":"none","far_end_camera_control":"\u003cboolean\u003e","feedback":"\u003cboolean\u003e","file_transfer":"\u003cboolean\u003e","group_hd":"\u003cboolean\u003e","webinar_group_hd":"\u003cboolean\u003e","join_from_desktop":"\u003cboolean\u003e","join_from_mobile":"\u003cboolean\u003e","auto_generated_translation":{"language_item_pairList":{"trans_lang_config":[{"speak_language":{"name":"Spanish","code":"fr"},"translate_to":{"all":"\u003cboolean\u003e","language_config":[{"name":"English","code":"en"}]}}],"all":"\u003cboolean\u003e"},"enable":"\u003cboolean\u003e"},"language_interpretation":{"custom_languages":["\u003cstring\u003e"],"enable_language_interpretation_by_default":"\u003cboolean\u003e","allow_participants_to_speak_in_listening_channel":"\u003cboolean\u003e","allow_up_to_25_custom_languages_when_scheduling_meetings":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"sign_language_interpretation":{"enable":"\u003cboolean\u003e","enable_sign_language_interpretation_by_default":"\u003cboolean\u003e","custom_languages":["\u003cstring\u003e"]},"live_streaming_facebook":"\u003cboolean\u003e","live_streaming_youtube":"\u003cboolean\u003e","manual_captioning":{"allow_to_type":"\u003cboolean\u003e","auto_generated_captions":"\u003cboolean\u003e","full_transcript":"\u003cboolean\u003e","manual_captions":"\u003cboolean\u003e","save_captions":"\u003cboolean\u003e","third_party_captioning_service":"\u003cboolean\u003e"},"meeting_reactions":"\u003cboolean\u003e","meeting_reactions_emojis":"selected","allow_host_panelists_to_use_audible_clap":"\u003cboolean\u003e","webinar_reactions":"\u003cboolean\u003e","meeting_survey":"\u003cboolean\u003e","non_verbal_feedback":"\u003cboolean\u003e","only_host_view_device_list":"\u003cboolean\u003e","original_audio":"\u003cboolean\u003e","polling":"\u003cboolean\u003e","post_meeting_feedback":"\u003cboolean\u003e","private_chat":"\u003cboolean\u003e","record_play_own_voice":"\u003cboolean\u003e","remote_control":"\u003cboolean\u003e","remote_support":"\u003cboolean\u003e","request_permission_to_unmute_participants":"\u003cboolean\u003e","screen_sharing":"\u003cboolean\u003e","sending_default_email_invites":"\u003cboolean\u003e","show_a_join_from_your_browser_link":"\u003cboolean\u003e","show_browser_join_link":"\u003cboolean\u003e","show_device_list":"\u003cboolean\u003e","show_meeting_control_toolbar":"\u003cboolean\u003e","slide_control":"\u003cboolean\u003e","stereo_audio":"\u003cboolean\u003e","use_html_format_email":"\u003cboolean\u003e","virtual_background":"\u003cboolean\u003e","waiting_room":"\u003cboolean\u003e","webinar_chat":{"allow_attendees_chat_with":3,"allow_auto_save_local_chat_file":"\u003cboolean\u003e","allow_panelists_chat_with":1,"allow_panelists_send_direct_message":"\u003cboolean\u003e","allow_users_save_chats":1,"default_attendees_chat_with":2,"enable":"\u003cboolean\u003e"},"webinar_live_streaming":{"custom_service_instructions":"\u003cstring\u003e","enable":"\u003cboolean\u003e","live_streaming_reminder":"\u003cboolean\u003e","live_streaming_service":["facebook"]},"meeting_polling":{"enable":"\u003cboolean\u003e","advanced_polls":"\u003cboolean\u003e","manage_saved_polls_and_quizzes":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e"},"webinar_polling":{"advanced_polls":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e","manage_saved_polls_and_quizzes":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"webinar_question_answer":"\u003cboolean\u003e","webinar_survey":"\u003cboolean\u003e","whiteboard":"\u003cboolean\u003e","who_can_share_screen":"host","who_can_share_screen_when_someone_is_sharing":"all","participants_share_simultaneously":"multiple","workplace_by_facebook":"\u003cboolean\u003e"},"other_options":{"allow_users_contact_support_via_chat":"\u003cboolean\u003e","blur_snapshot":"\u003cboolean\u003e","webinar_registration_options":{"allow_host_to_enable_join_info":"\u003cboolean\u003e","allow_host_to_enable_social_share_buttons":"\u003cboolean\u003e","enable_custom_questions":"\u003cboolean\u003e"}},"profile":{"recording_storage_location":{"allowed_values":["\u003cstring\u003e"],"value":"\u003cstring\u003e"}},"recording":{"account_user_access_recording":"\u003cboolean\u003e","archive":{"enable":"\u003cboolean\u003e","settings":{"audio_file":"\u003cboolean\u003e","cc_transcript_file":"\u003cboolean\u003e","chat_file":"\u003cboolean\u003e","chat_with_sender_email":"\u003cboolean\u003e","video_file":"\u003cboolean\u003e"},"type":1},"auto_recording":"\u003cstring\u003e","cloud_recording":"\u003cboolean\u003e","cloud_recording_download":"\u003cboolean\u003e","cloud_recording_download_host":"\u003cboolean\u003e","host_delete_cloud_recording":"\u003cboolean\u003e","record_files_separately":{"active_speaker":"\u003cboolean\u003e","gallery_view":"\u003cboolean\u003e","shared_screen":"\u003cboolean\u003e"},"display_participant_name":"\u003cboolean\u003e","recording_thumbnails":"\u003cboolean\u003e","optimize_recording_for_3rd_party_video_editor":"\u003cboolean\u003e","recording_highlight":"\u003cboolean\u003e","save_panelist_chat":"\u003cboolean\u003e","save_poll_results":"\u003cboolean\u003e","save_close_caption":"\u003cboolean\u003e","ip_address_access_control":{"enable":"\u003cboolean\u003e","ip_addresses_or_ranges":"\u003cstring\u003e"},"local_recording":"\u003cboolean\u003e","prevent_host_access_recording":"\u003cboolean\u003e","record_audio_file":"\u003cboolean\u003e","record_gallery_view":"\u003cboolean\u003e","record_speaker_view":"\u003cboolean\u003e","recording_audio_transcript":"\u003cboolean\u003e","smart_recording":{"create_recording_highlights":"\u003cboolean\u003e","create_smart_chapters":"\u003cboolean\u003e","create_next_steps":"\u003cboolean\u003e"},"save_chat_text":"\u003cboolean\u003e","show_timestamp":"\u003cboolean\u003e"},"schedule_meeting":{"audio_type":"\u003cstring\u003e","embed_password_in_join_link":"\u003cboolean\u003e","force_pmi_jbh_password":"\u003cboolean\u003e","host_video":"\u003cboolean\u003e","join_before_host":"\u003cboolean\u003e","mute_upon_entry":"\u003cboolean\u003e","participant_video":"\u003cboolean\u003e","pstn_password_protected":"\u003cboolean\u003e","require_password_for_all_meetings":"\u003cboolean\u003e","require_password_for_instant_meetings":"\u003cboolean\u003e","require_password_for_pmi_meetings":"all","require_password_for_scheduled_meetings":"\u003cboolean\u003e","require_password_for_scheduling_new_meetings":"\u003cboolean\u003e","upcoming_meeting_reminder":"\u003cboolean\u003e","always_display_zoom_meeting_as_topic":{"enable":"\u003cboolean\u003e","display_topic_for_scheduled_meetings":"\u003cboolean\u003e"},"always_display_zoom_webinar_as_topic":{"enable":"\u003cboolean\u003e","display_topic_for_scheduled_webinars":"\u003cboolean\u003e"},"continuous_meeting_chat":{"enable":"\u003cboolean\u003e","can_add_external_users":"\u003cboolean\u003e","auto_add_invited_external_users":"\u003cboolean\u003e"}},"telephony":{"audio_conference_info":"\u003cstring\u003e","third_party_audio":"\u003cboolean\u003e"},"chat":{"share_files":{"enable":"\u003cboolean\u003e","share_option":"anyone"},"chat_emojis":{"enable":"\u003cboolean\u003e","emojis_option":"all"},"record_voice_messages":"\u003cboolean\u003e","record_video_messages":"\u003cboolean\u003e","screen_capture":"\u003cboolean\u003e","create_public_channels":"\u003cboolean\u003e","create_private_channels":"\u003cboolean\u003e","share_links_in_chat":"\u003cboolean\u003e","schedule_meetings_in_chat":"\u003cboolean\u003e","set_retention_period_in_cloud":{"enable":"\u003cboolean\u003e","retention_period_of_direct_messages_and_group_conversation":"\u003cstring\u003e","retention_period_of_channels":"\u003cstring\u003e"},"set_retention_period_in_local":{"enable":"\u003cboolean\u003e","retention_period_of_direct_messages_and_group_conversation":"\u003cstring\u003e","retention_period_of_channels":"\u003cstring\u003e"},"allow_users_to_search_others_options":"\u003cstring\u003e","allow_users_to_add_contacts":{"enable":"\u003cboolean\u003e","selected_option":2,"user_email_addresses":"\u003cstring\u003e"},"allow_users_to_chat_with_others":{"enable":"\u003cboolean\u003e","selected_option":2,"user_email_addresses":"\u003cstring\u003e"},"chat_etiquette_tool":{"enable":false,"policies":[{"id":"\u003cstring\u003e","status":"deactivated"}]},"send_data_to_third_party_archiving_service":{"enable":"\u003cboolean\u003e"},"translate_messages":"\u003cboolean\u003e","search_and_send_animated_gif_images":{"enable":"\u003cboolean\u003e"}}}'

Ask Qodex
Introduction
FAQs
More
Github
Developer Website
Claim this page
Report this page

ENDPOINTS