Logo
Zoom Public API Documentation

Update user settings

PATCH {{baseUrl}}/users/:userId/settings?option=recording_authentication

Update a user's settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:write:admin,user:write

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description  
option
 string Optional query parameters: * `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. * `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.



HEADERS

Key Datatype Required Description  
Content-Type
 string




RESPONSES

status





Curl
curl -X PATCH 'https://api.zoom.us/v2/users/:userId/settings?option=recording_authentication?option=recording_authentication' -H 'Content-Type: application/json' -d '{"email_notification":{"alternative_host_reminder":false,"cancel_meeting_reminder":false,"cloud_recording_available_reminder":"\u003cboolean\u003e","jbh_reminder":false,"recording_available_reminder_alternative_hosts":"\u003cboolean\u003e","recording_available_reminder_schedulers":"\u003cboolean\u003e","schedule_for_reminder":false},"feature":{"concurrent_meeting":"Basic","large_meeting":"\u003cboolean\u003e","large_meeting_capacity":"\u003cinteger\u003e","meeting_capacity":"\u003cinteger\u003e","webinar":"\u003cboolean\u003e","webinar_capacity":500,"zoom_events":"\u003cboolean\u003e","zoom_events_capacity":30000,"zoom_events_unlimited":"\u003cboolean\u003e","zoom_events_unlimited_capacities":[1000,5000],"zoom_sessions_unlimited":"\u003cboolean\u003e","zoom_sessions_unlimited_capacities":[50000,20000],"zoom_events_pay_per_attendee":"\u003cboolean\u003e","zoom_sessions_pay_per_attendee":"\u003cboolean\u003e","zoom_phone":"\u003cboolean\u003e","zoom_iq_for_sales":"\u003cboolean\u003e","zoom_revenue_accelerator":"\u003cboolean\u003e","zoom_whiteboard":"\u003cboolean\u003e","zoom_whiteboard_plus":"\u003cboolean\u003e","zoom_translated_captions":"\u003cboolean\u003e","zoom_customer_managed_key":"\u003cboolean\u003e","zoom_huddles":"\u003cboolean\u003e","zoom_quality_management":"\u003cboolean\u003e","zoom_workforce_management":"\u003cboolean\u003e","zoom_scheduler":"\u003cboolean\u003e","zoom_clips_plus":"\u003cboolean\u003e","zoom_mail_calendar":"\u003cboolean\u003e"},"in_meeting":{"allow_host_to_enable_focus_mode":"\u003cboolean\u003e","allow_users_to_delete_messages_in_meeting_chat":"\u003cboolean\u003e","allow_live_streaming":"\u003cboolean\u003e","post_meeting_feedback":"\u003cboolean\u003e","whiteboard":"\u003cboolean\u003e","allow_participants_chat_with":2,"allow_users_save_chats":3,"annotation":false,"attendee_on_hold":false,"attention_mode_focus_mode":false,"auto_saving_chat":false,"breakout_room":false,"breakout_room_schedule":"\u003cboolean\u003e","chat":false,"meeting_question_answer":"\u003cboolean\u003e","closed_caption":false,"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":false,"custom_data_center_regions":"\u003cboolean\u003e","custom_live_streaming_service":"\u003cboolean\u003e","custom_service_instructions":"\u003cstring\u003e","data_center_regions":["IN","DE"],"disable_screen_sharing_for_host_meetings":"\u003cboolean\u003e","disable_screen_sharing_for_in_meeting_guests":"\u003cboolean\u003e","e2e_encryption":"\u003cboolean\u003e","entry_exit_chime":"all","far_end_camera_control":false,"feedback":false,"file_transfer":"\u003cboolean\u003e","group_hd":false,"webinar_group_hd":false,"join_from_desktop":"\u003cboolean\u003e","join_from_mobile":"\u003cboolean\u003e","language_interpretation":{"custom_languages":["\u003cstring\u003e","\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","languages":["Chinese","Chinese"],"custom_languages":["\u003cstring\u003e","\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":"all","allow_host_panelists_to_use_audible_clap":"\u003cboolean\u003e","webinar_reactions":"\u003cboolean\u003e","meeting_survey":"\u003cboolean\u003e","non_verbal_feedback":false,"polling":false,"private_chat":false,"record_play_voice":"\u003cboolean\u003e","remote_control":false,"remote_support":false,"request_permission_to_unmute_participants":"\u003cboolean\u003e","screen_sharing":"\u003cboolean\u003e","share_dual_camera":false,"show_a_join_from_your_browser_link":"\u003cboolean\u003e","show_meeting_control_toolbar":"\u003cboolean\u003e","slide_control":"\u003cboolean\u003e","virtual_background":false,"virtual_background_settings":{"allow_upload_custom":"\u003cboolean\u003e","allow_videos":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","files":[{"id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"\u003cstring\u003e"}]},"waiting_room":false,"webinar_chat":{"allow_attendees_chat_with":2,"allow_auto_save_local_chat_file":"\u003cboolean\u003e","allow_panelists_chat_with":1,"allow_panelists_send_direct_message":"\u003cboolean\u003e","allow_users_save_chats":0,"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":["workplace_by_facebook","custom_live_streaming_service"]},"meeting_polling":{"advanced_polls":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"webinar_polling":{"advanced_polls":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"webinar_survey":"\u003cboolean\u003e","who_can_share_screen":"all","who_can_share_screen_when_someone_is_sharing":"host","participants_share_simultaneously":"multiple","workplace_by_facebook":"\u003cboolean\u003e","auto_answer":"\u003cboolean\u003e","allow_show_zoom_windows":"\u003cboolean\u003e"},"profile":{"recording_storage_location":{"allowed_values":["\u003cstring\u003e","\u003cstring\u003e"],"value":"\u003cstring\u003e"}},"recording":{"ask_host_to_confirm_disclaimer":"\u003cboolean\u003e","ask_participants_to_consent_disclaimer":"\u003cboolean\u003e","auto_delete_cmr":false,"auto_delete_cmr_days":90,"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","auto_recording":"local","cloud_recording":false,"host_pause_stop_recording":false,"ip_address_access_control":{"enable":"\u003cboolean\u003e","ip_addresses_or_ranges":"\u003cstring\u003e"},"local_recording":"\u003cboolean\u003e","record_audio_file":false,"record_gallery_view":false,"record_speaker_view":false,"recording_audio_transcript":"\u003cboolean\u003e","recording_disclaimer":"\u003cboolean\u003e","smart_recording":{"create_recording_highlights":"\u003cboolean\u003e","create_smart_chapters":"\u003cboolean\u003e","create_next_steps":"\u003cboolean\u003e"},"recording_password_requirement":{"have_letter":"\u003cboolean\u003e","have_number":"\u003cboolean\u003e","have_special_character":"\u003cboolean\u003e","length":"\u003cinteger\u003e","only_allow_numeric":"\u003cboolean\u003e"},"save_chat_text":false,"show_timestamp":false},"schedule_meeting":{"audio_type":"voip","default_password_for_scheduled_meetings":"\u003cstring\u003e","embed_password_in_join_link":"\u003cboolean\u003e","force_pmi_jbh_password":"\u003cboolean\u003e","host_video":"\u003cboolean\u003e","join_before_host":"\u003cboolean\u003e","meeting_password_requirement":{"consecutive_characters_length":6,"have_letter":"\u003cboolean\u003e","have_number":"\u003cboolean\u003e","have_special_character":"\u003cboolean\u003e","have_upper_and_lower_characters":"\u003cboolean\u003e","length":"\u003cinteger\u003e","only_allow_numeric":"\u003cboolean\u003e","weak_enhance_detection":"\u003cboolean\u003e"},"participants_video":"\u003cboolean\u003e","personal_meeting":"\u003cboolean\u003e","pmi_password":"\u003cstring\u003e","pstn_password_protected":"\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","use_pmi_for_instant_meetings":"\u003cboolean\u003e","use_pmi_for_scheduled_meetings":"\u003cboolean\u003e"},"telephony":{"audio_conference_info":"","show_international_numbers_link":"\u003cboolean\u003e","telephony_regions":{"selection_values":"\u003cstring\u003e"},"third_party_audio":"\u003cboolean\u003e"},"tsp":{"call_out":"\u003cboolean\u003e","show_international_numbers_link":"\u003cboolean\u003e"}}'

  • Ask Qodex

  • Introduction

  • FAQs

  • More

    Github

    Developer Website

    Claim this page

    Report this page

ENDPOINTS