Update a user's profile

PATCH {{baseUrl}}/phone/users/:userId

Updates a user's Zoom Phone profile. For user-level apps, pass the me value instead of the userId parameter.

To add, update or remove the shared access members for voicemail and call recordings, use the Add / Update / Delete a user's shared access setting API.

Prerequisites:

  • A Business or Enterprise account
  • A Zoom Phone license

Scopes: phone:write , phone:write:admin

Granular Scopes: phone:update:user , phone:update:user:admin

Rate Limit Label : Light

Request Body

{"emergency_address_id"=>"<string>", "extension_number"=>"<string>", "policy"=>{"ad_hoc_call_recording"=>{"enable"=>"<boolean>", "recording_start_prompt"=>"<boolean>", "recording_transcription"=>"<boolean>", "reset"=>"<boolean>", "play_recording_beep_tone"=>{"enable"=>"<boolean>", "play_beep_volume"=>40, "play_beep_time_interval"=>30, "play_beep_member"=>"recordingSide"}}, "auto_call_recording"=>{"allow_stop_resume_recording"=>"<boolean>", "disconnect_on_recording_failure"=>"<boolean>", "enable"=>"<boolean>", "recording_calls"=>"inbound", "recording_explicit_consent"=>"<boolean>", "recording_start_prompt"=>"<boolean>", "recording_transcription"=>"<boolean>", "play_recording_beep_tone"=>{"enable"=>"<boolean>", "play_beep_volume"=>20, "play_beep_time_interval"=>60, "play_beep_member"=>"allMember"}, "reset"=>"<boolean>"}, "call_overflow"=>{"call_overflow_type"=>4, "enable"=>"<boolean>", "reset"=>"<boolean>"}, "call_park"=>{"call_not_picked_up_action"=>"<integer>", "enable"=>"<boolean>", "expiration_period"=>4, "forward_to_extension_id"=>"<string>"}, "call_transferring"=>{"call_transferring_type"=>4, "enable"=>"<boolean>", "reset"=>"<boolean>"}, "delegation"=>"<boolean>", "elevate_to_meeting"=>"<boolean>", "emergency_address_management"=>{"enable"=>"<boolean>", "prompt_default_address"=>"<boolean>"}, "emergency_calls_to_psap"=>"<boolean>", "forwarding_to_external_numbers"=>"<boolean>", "call_handling_forwarding_to_other_users"=>{"enable"=>"<boolean>", "call_forwarding_type"=>1, "reset"=>"<boolean>"}, "hand_off_to_room"=>{"enable"=>"<boolean>"}, "international_calling"=>"<boolean>", "mobile_switch_to_carrier"=>{"enable"=>"<boolean>"}, "select_outbound_caller_id"=>{"enable"=>"<boolean>", "allow_hide_outbound_caller_id"=>"<boolean>"}, "sms"=>{"enable"=>"<boolean>", "international_sms"=>"<boolean>", "international_sms_countries"=>["<string>", "<string>"]}, "voicemail"=>{"allow_delete"=>"<boolean>", "allow_download"=>"<boolean>", "allow_transcription"=>"<boolean>", "allow_videomail"=>"<boolean>", "enable"=>"<boolean>"}, "voicemail_access_members"=>[{"access_user_id"=>"<string>", "allow_delete"=>"<boolean>", "allow_download"=>"<boolean>", "allow_sharing"=>"<boolean>"}, {"access_user_id"=>"<string>", "allow_delete"=>"<boolean>", "allow_download"=>"<boolean>", "allow_sharing"=>"<boolean>"}], "zoom_phone_on_mobile"=>{"allow_calling_sms_mms"=>"<boolean>", "enable"=>"<boolean>"}, "personal_audio_library"=>{"allow_music_on_hold_customization"=>"<boolean>", "allow_voicemail_and_message_greeting_customization"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>"}, "voicemail_transcription"=>{"enable"=>"<boolean>", "reset"=>"<boolean>"}, "voicemail_notification_by_email"=>{"include_voicemail_file"=>"<boolean>", "include_voicemail_transcription"=>"<boolean>", "enable"=>"<boolean>", "reset"=>"<boolean>"}, "shared_voicemail_notification_by_email"=>{"enable"=>"<boolean>", "reset"=>"<boolean>"}, "check_voicemails_over_phone"=>{"enable"=>"<boolean>", "reset"=>"<boolean>"}, "audio_intercom"=>{"enable"=>"<boolean>", "reset"=>"<boolean>"}, "e2e_encryption"=>{"enable"=>"<boolean>", "reset"=>"<boolean>"}}, "site_id"=>"<string>", "template_id"=>"<string>"}

HEADERS

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

RESPONSES

status: ``