Update account settings
PATCH {{baseUrl}}/accounts/:accountId/settings?option=recording_authentication
Update an account's settings.
To update the settings for a master account, pass the
me
value for the
accountId
path parameter.
Prerequisites:
- The account must be a paid account.
Scopes:
account:write:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| option
| string | | Optional query parameters.
meeting_authentication
- View the meeting authentication settings applied to the user's account.recording_authentication
- View the recording authentication settings applied to the user's account.security
- View the account's security settings. For example, passcode requirements for user login or two-factor authentication.meeting_security
- View the meeting security settings applied to the user's account. |
Request Body
{"security"=>{"admin_change_name_pic"=>"<boolean>", "admin_change_user_info"=>"<boolean>", "user_modifiable_info_by_admin"=>["profile_picture"], "signin_with_sso"=>{"enable"=>"<boolean>", "require_sso_for_domains"=>"<boolean>", "domains"=>["<string>"], "sso_bypass_user_ids"=>["<string>"]}, "hide_billing_info"=>"<boolean>", "import_photos_from_devices"=>"<boolean>", "password_requirement"=>{"consecutive_characters_length"=>"<integer>", "have_special_character"=>"<boolean>", "minimum_password_length"=>"<integer>", "weak_enhance_detection"=>"<boolean>"}, "sign_again_period_for_inactivity_on_client"=>"<integer>", "sign_again_period_for_inactivity_on_web"=>"<integer>", "sign_in_with_two_factor_auth"=>"group", "sign_in_with_two_factor_auth_groups"=>["<string>"], "sign_in_with_two_factor_auth_roles"=>["<string>"]}, "audio_conferencing"=>{"toll_free_and_fee_based_toll_call"=>{"allow_webinar_attendees_dial"=>"<boolean>", "enable"=>"<boolean>", "numbers"=>[{"code"=>"<string>", "country_code"=>"<string>", "country_name"=>"<string>", "display_number"=>"<string>", "number"=>"<string>"}]}}, "chat"=>{"allow_bots_chat"=>"<boolean>", "share_files"=>{"enable"=>"<boolean>", "share_option"=>"account", "restrictions"=>{"only_allow_specific_file_types"=>"<boolean>", "file_type_restrictions"=>[".ppt"], "file_type_restrictions_for_external"=>[".png"], "maximum_file_size"=>"<boolean>", "file_size_restrictions"=>500, "file_size_restrictions_for_external"=>400}}, "chat_emojis"=>{"enable"=>"<boolean>", "emojis_option"=>"all"}, "record_voice_messages"=>"<boolean>", "record_video_messages"=>"<boolean>", "screen_capture"=>"<boolean>", "create_public_channels"=>"<boolean>", "create_private_channels"=>"<boolean>", "share_links_in_chat"=>"<boolean>", "schedule_meetings_in_chat"=>"<boolean>", "set_retention_period_in_cloud"=>{"enable"=>"<boolean>", "retention_period_of_direct_messages_and_group_conversation"=>"<string>", "retention_period_of_channels"=>"<string>"}, "set_retention_period_in_local"=>{"enable"=>"<boolean>", "retention_period_of_direct_messages_and_group_conversation"=>"<string>", "retention_period_of_channels"=>"<string>"}, "allow_users_to_add_contacts"=>{"enable"=>"<boolean>", "selected_option"=>2, "user_email_addresses"=>"<string>"}, "allow_users_to_chat_with_others"=>{"enable"=>"<boolean>", "selected_option"=>1, "user_email_addresses"=>"<string>"}, "chat_etiquette_tool"=>{"enable"=>false, "operate"=>"create", "policies"=>[{"description"=>"<string>", "id"=>"<string>", "is_locked"=>false, "keywords"=>["<string>"], "name"=>"<string>", "regular_expression"=>"<string>", "status"=>"deactivated", "trigger_action"=>1}]}, "send_data_to_third_party_archiving_service"=>{"enable"=>"<boolean>", "type"=>"smarsh", "smtp_delivery_address"=>"<string>", "user_name"=>"<string>", "passcode"=>"<string>", "authorized_channel_token"=>"<string>"}, "apply_local_storage_to_personal_channel"=>{"enable"=>"<boolean>", "retention_period"=>"<string>"}, "translate_messages"=>"<boolean>", "search_and_send_animated_gif_images"=>{"enable"=>"<boolean>", "giphy_content_rating"=>2}}, "email_notification"=>{"alternative_host_reminder"=>"<boolean>", "cancel_meeting_reminder"=>"<boolean>", "cloud_recording_available_reminder"=>"<boolean>", "jbh_reminder"=>"<boolean>", "low_host_count_reminder"=>"<boolean>", "recording_available_reminder_alternative_hosts"=>"<boolean>", "recording_available_reminder_schedulers"=>"<boolean>", "schedule_for_reminder"=>"<boolean>"}, "feature"=>{"meeting_capacity"=>"<integer>"}, "in_meeting"=>{"alert_guest_join"=>"<boolean>", "allow_host_to_enable_focus_mode"=>"<boolean>", "allow_live_streaming"=>"<boolean>", "allow_users_to_delete_messages_in_meeting_chat"=>"<boolean>", "allow_participants_chat_with"=>1, "allow_participants_to_rename"=>"<boolean>", "allow_show_zoom_windows"=>"<boolean>", "allow_users_save_chats"=>2, "annotation"=>"<boolean>", "anonymous_question_answer"=>"<boolean>", "attendee_on_hold"=>false, "attention_mode_focus_mode"=>false, "auto_answer"=>"<boolean>", "auto_saving_chat"=>"<boolean>", "breakout_room"=>"<boolean>", "breakout_room_schedule"=>"<boolean>", "chat"=>"<boolean>", "meeting_question_answer"=>"<boolean>", "closed_caption"=>"<boolean>", "closed_captioning"=>{"auto_transcribing"=>"<boolean>", "enable"=>"<boolean>", "save_caption"=>"<boolean>", "third_party_captioning_service"=>"<boolean>", "view_full_transcript"=>"<boolean>"}, "co_host"=>"<boolean>", "custom_data_center_regions"=>"<boolean>", "custom_live_streaming_service"=>"<boolean>", "custom_service_instructions"=>"<string>", "meeting_data_transit_and_residency_method"=>"On-Prem", "data_center_regions"=>["LA"], "disable_screen_sharing_for_host_meetings"=>"<boolean>", "disable_screen_sharing_for_in_meeting_guests"=>"<boolean>", "dscp_audio"=>56, "dscp_marking"=>"<boolean>", "dscp_video"=>40, "dscp_dual"=>"<boolean>", "e2e_encryption"=>"<boolean>", "entry_exit_chime"=>"host", "far_end_camera_control"=>"<boolean>", "feedback"=>"<boolean>", "file_transfer"=>"<boolean>", "group_hd"=>"<boolean>", "webinar_group_hd"=>"<boolean>", "join_from_desktop"=>"<boolean>", "join_from_mobile"=>"<boolean>", "auto_generated_translation"=>{"language_item_pairList"=>{"trans_lang_config"=>[{"speak_language"=>{"name"=>"Ukrainian", "code"=>"es"}, "translate_to"=>{"all"=>"<boolean>", "language_config"=>[{"name"=>"English", "code"=>"en"}]}}], "all"=>"<boolean>"}, "enable"=>"<boolean>"}, "language_interpretation"=>{"custom_languages"=>["<string>"], "enable_language_interpretation_by_default"=>"<boolean>", "allow_participants_to_speak_in_listening_channel"=>"<boolean>", "allow_up_to_25_custom_languages_when_scheduling_meetings"=>"<boolean>", "enable"=>"<boolean>"}, "sign_language_interpretation"=>{"enable"=>"<boolean>", "enable_sign_language_interpretation_by_default"=>"<boolean>", "custom_languages"=>["<string>"]}, "live_streaming_facebook"=>"<boolean>", "live_streaming_youtube"=>"<boolean>", "manual_captioning"=>{"allow_to_type"=>"<boolean>", "auto_generated_captions"=>"<boolean>", "full_transcript"=>"<boolean>", "manual_captions"=>"<boolean>", "save_captions"=>"<boolean>", "third_party_captioning_service"=>"<boolean>"}, "meeting_polling"=>{"advanced_polls"=>"<boolean>", "allow_alternative_host_to_add_edit"=>"<boolean>", "require_answers_to_be_anonymous"=>"<boolean>", "manage_saved_polls_and_quizzes"=>"<boolean>", "allow_host_to_upload_image"=>"<boolean>", "enable"=>"<boolean>"}, "meeting_reactions"=>"<boolean>", "meeting_reactions_emojis"=>"selected", "allow_host_panelists_to_use_audible_clap"=>"<boolean>", "webinar_reactions"=>"<boolean>", "meeting_survey"=>"<boolean>", "original_audio"=>"<boolean>", "p2p_connetion"=>"<boolean>", "p2p_ports"=>"<boolean>", "polling"=>"<boolean>", "ports_range"=>"", "post_meeting_feedback"=>"<boolean>", "private_chat"=>"<boolean>", "record_play_own_voice"=>"<boolean>", "remote_control"=>"<boolean>", "non_verbal_feedback"=>false, "remote_support"=>false, "request_permission_to_unmute_participants"=>"<boolean>", "screen_sharing"=>"<boolean>", "sending_default_email_invites"=>"<boolean>", "show_a_join_from_your_browser_link"=>"<boolean>", "show_meeting_control_toolbar"=>"<boolean>", "slide_control"=>"<boolean>", "stereo_audio"=>"<boolean>", "use_html_format_email"=>"<boolean>", "virtual_background"=>"<boolean>", "virtual_background_settings"=>{"allow_upload_custom"=>"<boolean>", "allow_videos"=>"<boolean>", "enable"=>"<boolean>", "files"=>[{"id"=>"<string>", "is_default"=>"<boolean>", "name"=>"<string>", "size"=>"<integer>", "type"=>"<string>"}]}, "watermark"=>"<boolean>", "webinar_chat"=>{"allow_attendees_chat_with"=>2, "allow_auto_save_local_chat_file"=>"<boolean>", "allow_panelists_chat_with"=>1, "allow_panelists_send_direct_message"=>"<boolean>", "allow_users_save_chats"=>0, "default_attendees_chat_with"=>2, "enable"=>"<boolean>"}, "webinar_live_streaming"=>{"custom_service_instructions"=>"<string>", "enable"=>"<boolean>", "live_streaming_reminder"=>"<boolean>", "live_streaming_service"=>["custom_live_streaming_service"]}, "webinar_polling"=>{"advanced_polls"=>"<boolean>", "allow_alternative_host_to_add_edit"=>"<boolean>", "require_answers_to_be_anonymous"=>"<boolean>", "manage_saved_polls_and_quizzes"=>"<boolean>", "allow_host_to_upload_image"=>"<boolean>", "enable"=>"<boolean>"}, "webinar_question_answer"=>"<boolean>", "webinar_survey"=>"<boolean>", "whiteboard"=>"<boolean>", "who_can_share_screen"=>"host", "who_can_share_screen_when_someone_is_sharing"=>"all", "participants_share_simultaneously"=>"one", "workplace_by_facebook"=>"<boolean>", "transfer_meetings_between_devices"=>"<boolean>"}, "integration"=>{"box"=>"<boolean>", "dropbox"=>"<boolean>", "google_calendar"=>"<boolean>", "google_drive"=>"<boolean>", "kubi"=>"<boolean>", "microsoft_one_drive"=>"<boolean>"}, "other_options"=>{"allow_auto_active_users"=>"<boolean>", "allow_users_contact_support_via_chat"=>"<boolean>", "allow_users_enter_and_share_pronouns"=>"<boolean>", "blur_snapshot"=>"<boolean>", "display_meetings_scheduled_for_others"=>"<boolean>", "meeting_qos_and_mos"=>1, "show_one_user_meeting_on_dashboard"=>"<boolean>", "use_cdn"=>"default", "webinar_registration_options"=>{"allow_host_to_enable_join_info"=>"<boolean>", "allow_host_to_enable_social_share_buttons"=>"<boolean>", "enable_custom_questions"=>"<boolean>"}, "email_in_attendee_report_for_meeting"=>"<boolean>"}, "profile"=>{"recording_storage_location"=>{"allowed_values"=>["<string>"], "value"=>"<string>"}}, "recording"=>{"account_user_access_recording"=>"<boolean>", "allow_recovery_deleted_cloud_recordings"=>"<boolean>", "archive"=>{"enable"=>"<boolean>", "settings"=>{"audio_file"=>"<boolean>", "cc_transcript_file"=>"<boolean>", "chat_file"=>"<boolean>", "chat_with_sender_email"=>"<boolean>", "video_file"=>"<boolean>", "chat_with_direct_message"=>"<boolean>", "archive_retention"=>10, "action_when_archive_failed"=>1, "notification_when_archiving_starts"=>"guest", "play_voice_prompt_when_archiving_starts"=>"participants"}, "type"=>2}, "auto_delete_cmr"=>"<boolean>", "auto_delete_cmr_days"=>120, "auto_recording"=>"none", "cloud_recording"=>"<boolean>", "cloud_recording_download"=>"<boolean>", "cloud_recording_download_host"=>"<boolean>", "display_participant_name"=>"<boolean>", "host_delete_cloud_recording"=>"<boolean>", "ip_address_access_control"=>{"enable"=>"<boolean>", "ip_addresses_or_ranges"=>"<string>"}, "local_recording"=>"<boolean>", "optimize_recording_for_3rd_party_video_editor"=>"<boolean>", "prevent_host_access_recording"=>"<boolean>", "record_audio_file"=>"<boolean>", "record_audio_file_each_participant"=>"<boolean>", "record_files_separately"=>{"active_speaker"=>"<boolean>", "gallery_view"=>"<boolean>", "shared_screen"=>"<boolean>"}, "record_gallery_view"=>"<boolean>", "record_speaker_view"=>"<boolean>", "recording_audio_transcript"=>"<boolean>", "recording_disclaimer"=>"<boolean>", "recording_highlight"=>"<boolean>", "smart_recording"=>{"create_recording_highlights"=>"<boolean>", "create_smart_chapters"=>"<boolean>", "create_next_steps"=>"<boolean>"}, "recording_password_requirement"=>{"have_letter"=>"<boolean>", "have_number"=>"<boolean>", "have_special_character"=>"<boolean>", "length"=>"<integer>", "only_allow_numeric"=>"<boolean>"}, "recording_thumbnails"=>"<boolean>", "required_password_for_existing_cloud_recordings"=>"<boolean>", "required_password_for_shared_cloud_recordings"=>"<boolean>", "save_chat_text"=>"<boolean>", "save_close_caption"=>"<boolean>", "save_panelist_chat"=>"<boolean>", "save_poll_results"=>"<boolean>", "show_timestamp"=>"<boolean>"}, "schedule_meeting"=>{"audio_type"=>"both", "enforce_login"=>"<boolean>", "enforce_login_domains"=>"<string>", "enforce_login_with_domains"=>"<boolean>", "force_pmi_jbh_password"=>"<boolean>", "host_video"=>"<boolean>", "enable_dedicated_group_chat"=>"<boolean>", "jbh_time"=>10, "join_before_host"=>"<boolean>", "meeting_password_requirement"=>{"consecutive_characters_length"=>0, "have_letter"=>"<boolean>", "have_number"=>"<boolean>", "have_special_character"=>"<boolean>", "have_upper_and_lower_characters"=>"<boolean>", "length"=>"<integer>", "only_allow_numeric"=>"<boolean>", "weak_enhance_detection"=>"<boolean>"}, "not_store_meeting_topic"=>"<boolean>", "participant_video"=>"<boolean>", "allow_host_to_disable_participant_video"=>"<boolean>", "personal_meeting"=>"<boolean>", "require_password_for_instant_meetings"=>"<boolean>", "require_password_for_pmi_meetings"=>"jbh_only", "require_password_for_scheduled_meetings"=>"<boolean>", "require_password_for_scheduling_new_meetings"=>"<boolean>", "use_pmi_for_instant_meetings"=>"<boolean>", "use_pmi_for_scheduled_meetings"=>"<boolean>", "always_display_zoom_meeting_as_topic"=>{"enable"=>"<boolean>", "display_topic_for_scheduled_meetings"=>"<boolean>"}, "hide_meeting_description"=>{"enable"=>"<boolean>", "hide_description_for_scheduled_meetings"=>"<boolean>"}, "always_display_zoom_webinar_as_topic"=>{"enable"=>"<boolean>", "display_topic_for_scheduled_webinars"=>"<boolean>"}, "hide_webinar_description"=>{"enable"=>"<boolean>", "hide_description_for_scheduled_webinars"=>"<boolean>"}, "meeting_template"=>{"enable"=>"<boolean>", "action"=>"<string>", "templates"=>[{"id"=>"<string>", "enable"=>"<boolean>"}]}, "continuous_meeting_chat"=>{"enable"=>"<boolean>", "can_add_external_users"=>"<boolean>", "auto_add_invited_external_users"=>"<boolean>"}}, "telephony"=>{"audio_conference_info"=>"<string>", "telephony_regions"=>{"selection_values"=>"<string>"}, "third_party_audio"=>"<boolean>"}, "tsp"=>{"call_out"=>"<boolean>", "call_out_countries"=>["<string>"], "display_toll_free_numbers"=>"<boolean>", "show_international_numbers_link"=>"<boolean>"}, "zoom_rooms"=>{"auto_start_stop_scheduled_meetings"=>"<boolean>", "cmr_for_instant_meeting"=>"<boolean>", "force_private_meeting"=>"<boolean>", "hide_host_information"=>"<boolean>", "list_meetings_with_calendar"=>"<boolean>", "start_airplay_manually"=>"<boolean>", "ultrasonic"=>"<boolean>", "upcoming_meeting_alert"=>"<boolean>", "weekly_system_restart"=>"<boolean>", "zr_post_meeting_feedback"=>"<boolean>"}}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type
| string | | |
RESPONSES
status: ``