Update phone site details

PATCH {{baseUrl}}/phone/sites/:siteId

Updates information about a specific site . It allows you to organize Zoom Phone users in your organization.

Prerequisites:

  • Account must have a Pro or a higher plan with Zoom Phone license.

Scopes: phone:write:admin

Granular Scopes: phone:update:site:admin

Rate Limit Label : LIGHT

Request Body

{"name"=>"<string>", "site_code"=>"<integer>", "short_extension"=>{"length"=>"<integer>", "ranges"=>[{"range_from"=>"<string>", "range_to"=>"<string>"}, {"range_from"=>"<string>", "range_to"=>"<string>"}]}, "default_emergency_address"=>{"address_line1"=>"<string>", "city"=>"<string>", "country"=>"<string>", "state_code"=>"<string>", "zip"=>"<string>", "address_line2"=>"<string>"}, "sip_zone"=>{"id"=>"<string>"}, "caller_id_name"=>"<string>", "policy"=>{"select_outbound_caller_id"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "allow_hide_outbound_caller_id"=>"<boolean>"}, "personal_audio_library"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "allow_music_on_hold_customization"=>"<boolean>", "allow_voicemail_and_message_greeting_customization"=>"<boolean>"}, "voicemail"=>{"allow_delete"=>"<boolean>", "allow_download"=>"<boolean>", "allow_videomail"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "voicemail_transcription"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "voicemail_notification_by_email"=>{"include_voicemail_file"=>"<boolean>", "include_voicemail_transcription"=>"<boolean>", "forward_voicemail_to_email"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "shared_voicemail_notification_by_email"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "international_calling"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "zoom_phone_on_mobile"=>{"allow_calling_sms_mms"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "sms"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "international_sms"=>"<boolean>", "international_sms_countries"=>["<string>", "<string>"]}, "elevate_to_meeting"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "hand_off_to_room"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "mobile_switch_to_carrier"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "delegation"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "ad_hoc_call_recording"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "recording_start_prompt"=>"<boolean>", "recording_transcription"=>"<boolean>", "play_recording_beep_tone"=>{"enable"=>"<boolean>", "play_beep_volume"=>40, "play_beep_time_interval"=>5, "play_beep_member"=>"allMember"}}, "auto_call_recording"=>{"allow_stop_resume_recording"=>"<boolean>", "disconnect_on_recording_failure"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "recording_calls"=>"inbound", "recording_explicit_consent"=>"<boolean>", "recording_start_prompt"=>"<boolean>", "recording_transcription"=>"<boolean>", "play_recording_beep_tone"=>{"enable"=>"<boolean>", "play_beep_volume"=>40, "play_beep_time_interval"=>5, "play_beep_member"=>"recordingSide"}}, "call_handling_forwarding_to_other_users"=>{"enable"=>"<boolean>", "call_forwarding_type"=>1, "reset"=>"<boolean>", "locked"=>"<boolean>"}, "check_voicemails_over_phone"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "call_queue_pickup_code"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "call_queue_opt_out_reason"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "call_queue_opt_out_reasons_list"=>[{"code"=>"<string>", "system"=>"<boolean>", "enable"=>"<boolean>"}, {"code"=>"<string>", "system"=>"<boolean>", "enable"=>"<boolean>"}]}, "show_user_last_transferred_call"=>"<boolean>", "auto_delete_data_after_retention_duration"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "items"=>[{"type"=>"onDemandRecording", "duration"=>"<integer>", "time_unit"=>"month"}, {"type"=>"onDemandRecording", "duration"=>"<integer>", "time_unit"=>"day"}], "delete_type"=>2}, "call_park"=>{"call_not_picked_up_action"=>"<integer>", "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "expiration_period"=>2, "forward_to_extension_id"=>"<string>", "sequence"=>0}, "call_overflow"=>{"call_overflow_type"=>3, "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "call_transferring"=>{"call_transferring_type"=>4, "enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "audio_intercom"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "block_calls_without_caller_id"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>"}, "block_external_calls"=>{"enable"=>"<boolean>", "reset"=>"<boolean>", "locked"=>"<boolean>", "block_business_hours"=>"<boolean>", "block_closed_hours"=>"<boolean>", "block_holiday_hours"=>"<boolean>", "block_call_action"=>9, "block_call_change_type"=>1, "e2e_encryption"=>{"enable"=>"<boolean>", "locked"=>"<boolean>", "locked_by"=>"account", "modified"=>"<boolean>"}}, "force_off_net"=>{"enable"=>"<boolean>", "allow_extension_only_users_call_users_outside_site"=>"<boolean>"}}}

HEADERS

| Key | Datatype | Required | Description | | Content-Type | string | | |

RESPONSES

status: ``