Zoom Public API Documentation
Update a user's profile
PATCH {{baseUrl}}/phone/users/:userId
Updates a user's Zoom Phone profile. For user-level apps, pass the 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: Granular Scopes: Rate Limit Label: me value instead of the userId parameter.phone:write,phone:write:adminphone:update:user,phone:update:user:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status
Curl
curl -X PATCH 'https://api.zoom.us/v2/phone/users/:userId' -H 'Content-Type: application/json' -d '{"emergency_address_id":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","policy":{"ad_hoc_call_recording":{"enable":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","reset":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":40,"play_beep_time_interval":30,"play_beep_member":"recordingSide"}},"auto_call_recording":{"allow_stop_resume_recording":"\u003cboolean\u003e","disconnect_on_recording_failure":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","recording_calls":"inbound","recording_explicit_consent":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":20,"play_beep_time_interval":60,"play_beep_member":"allMember"},"reset":"\u003cboolean\u003e"},"call_overflow":{"call_overflow_type":4,"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"call_park":{"call_not_picked_up_action":"\u003cinteger\u003e","enable":"\u003cboolean\u003e","expiration_period":4,"forward_to_extension_id":"\u003cstring\u003e"},"call_transferring":{"call_transferring_type":4,"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"delegation":"\u003cboolean\u003e","elevate_to_meeting":"\u003cboolean\u003e","emergency_address_management":{"enable":"\u003cboolean\u003e","prompt_default_address":"\u003cboolean\u003e"},"emergency_calls_to_psap":"\u003cboolean\u003e","forwarding_to_external_numbers":"\u003cboolean\u003e","call_handling_forwarding_to_other_users":{"enable":"\u003cboolean\u003e","call_forwarding_type":1,"reset":"\u003cboolean\u003e"},"hand_off_to_room":{"enable":"\u003cboolean\u003e"},"international_calling":"\u003cboolean\u003e","mobile_switch_to_carrier":{"enable":"\u003cboolean\u003e"},"select_outbound_caller_id":{"enable":"\u003cboolean\u003e","allow_hide_outbound_caller_id":"\u003cboolean\u003e"},"sms":{"enable":"\u003cboolean\u003e","international_sms":"\u003cboolean\u003e","international_sms_countries":["\u003cstring\u003e","\u003cstring\u003e"]},"voicemail":{"allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_transcription":"\u003cboolean\u003e","allow_videomail":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"voicemail_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e"}],"zoom_phone_on_mobile":{"allow_calling_sms_mms":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"personal_audio_library":{"allow_music_on_hold_customization":"\u003cboolean\u003e","allow_voicemail_and_message_greeting_customization":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"voicemail_transcription":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"voicemail_notification_by_email":{"include_voicemail_file":"\u003cboolean\u003e","include_voicemail_transcription":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"shared_voicemail_notification_by_email":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"check_voicemails_over_phone":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"audio_intercom":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"},"e2e_encryption":{"enable":"\u003cboolean\u003e","reset":"\u003cboolean\u003e"}},"site_id":"\u003cstring\u003e","template_id":"\u003cstring\u003e"}'
ENDPOINTS