Logo
Zoom Public API Documentation

Update locked settings

PATCH {{baseUrl}}/groups/:groupId/lock_settings?option=<string>

Update a group's locked settings. If you lock a setting, the group members cannot modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is deprecated as of September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>

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_security` - View the meeting security settings applied to the user's account.



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status





Curl
curl -X PATCH 'https://api.zoom.us/v2/groups/:groupId/lock_settings?option=<string>?option=<string>' -H 'Content-Type: application/json' -d '{"audio_conferencing":{"toll_free_and_fee_based_toll_call":"\u003cboolean\u003e"},"email_notification":{"alternative_host_reminder":"\u003cboolean\u003e","cancel_meeting_reminder":"\u003cboolean\u003e","cloud_recording_available_reminder":"\u003cboolean\u003e","jbh_reminder":"\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_show_zoom_windows":"\u003cboolean\u003e","annotation":"\u003cboolean\u003e","attendee_on_hold":false,"auto_answer":"\u003cboolean\u003e","auto_generated_captions":"\u003cboolean\u003e","auto_saving_chat":"\u003cboolean\u003e","breakout_room":"\u003cboolean\u003e","chat":"\u003cboolean\u003e","meeting_question_answer":"\u003cboolean\u003e","closed_caption":"\u003cboolean\u003e","co_host":"\u003cboolean\u003e","custom_data_center_regions":"\u003cboolean\u003e","disable_screen_sharing_for_host_meetings":"\u003cboolean\u003e","disable_screen_sharing_for_in_meeting_guests":"\u003cboolean\u003e","e2e_encryption":"\u003cboolean\u003e","entry_exit_chime":"\u003cstring\u003e","far_end_camera_control":"\u003cboolean\u003e","feedback":"\u003cboolean\u003e","file_transfer":"\u003cboolean\u003e","full_transcript":"\u003cboolean\u003e","group_hd":"\u003cboolean\u003e","webinar_group_hd":"\u003cboolean\u003e","language_interpretation":"\u003cboolean\u003e","sign_language_interpretation":"\u003cboolean\u003e","webinar_reactions":"\u003cboolean\u003e","meeting_survey":"\u003cboolean\u003e","non_verbal_feedback":"\u003cboolean\u003e","original_audio":"\u003cboolean\u003e","polling":"\u003cboolean\u003e","post_meeting_feedback":"\u003cboolean\u003e","private_chat":"\u003cboolean\u003e","remote_control":"\u003cboolean\u003e","remote_support":"\u003cboolean\u003e","request_permission_to_unmute_participants":"\u003cboolean\u003e","save_caption":"\u003cboolean\u003e","save_captions":"\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_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":"\u003cboolean\u003e","webinar_live_streaming":"\u003cboolean\u003e","webinar_polling":"\u003cboolean\u003e","webinar_question_answer":"\u003cboolean\u003e","webinar_survey":"\u003cboolean\u003e","whiteboard":"\u003cboolean\u003e"},"other_options":{"blur_snapshot":"\u003cboolean\u003e"},"recording":{"account_user_access_recording":"\u003cboolean\u003e","auto_delete_cmr":"\u003cboolean\u003e","auto_recording":"\u003cboolean\u003e","cloud_recording":"\u003cboolean\u003e","cloud_recording_download":"\u003cboolean\u003e","host_delete_cloud_recording":"\u003cboolean\u003e","ip_address_access_control":{"enable":"\u003cboolean\u003e","ip_addresses_or_ranges":"\u003cstring\u003e"},"local_recording":"\u003cboolean\u003e","recording_authentication":"\u003cboolean\u003e","archive":"\u003cboolean\u003e"},"schedule_meeting":{"audio_type":"\u003cboolean\u003e","embed_password_in_join_link":"\u003cboolean\u003e","force_pmi_jbh_password":"\u003cboolean\u003e","host_video":"\u003cboolean\u003e","join_before_host":"\u003cboolean\u003e","meeting_authentication":"\u003cboolean\u003e","mute_upon_entry":"\u003cboolean\u003e","participant_video":"\u003cboolean\u003e","personal_meeting":"\u003cboolean\u003e","pstn_password_protected":"\u003cboolean\u003e","require_password_for_instant_meetings":"\u003cboolean\u003e","require_password_for_pmi_meetings":"\u003cboolean\u003e","require_password_for_scheduling_new_meetings":"\u003cboolean\u003e","upcoming_meeting_reminder":"\u003cboolean\u003e","continuous_meeting_chat":"\u003cboolean\u003e"},"telephony":{"telephony_regions":"\u003cboolean\u003e","third_party_audio":"\u003cboolean\u003e"}}'

ENDPOINTS