Update a user's shared access setting
PATCH
{{baseUrl}}/phone/users/:userId/settings/:settingType
Updates the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass the me
value instead of the userId
parameter.
To see the shared access settings in the Zoom web portal, go to Admin > Phone System Management > Users & Rooms . Click Users and select User Policy. Go to Voicemail, Automatic Call Recording and Ad Hoc Call Recording.
To view the delegation and intercom setting in your Zoom web portal, navigate to Admin > Phone System Management > Users & Rooms. Click the Users tab and select User Settings
Prerequisites:
* A Business or Enterprise account
Scopes: phone:write:admin
,phone:write
Granular Scopes: phone:update:shared_setting
,phone:update:shared_setting:admin
Rate Limit Label: Light
Body
PARAM
Key |
Datatype |
Required |
Description |
HEADERS
Key |
Datatype |
Required |
Description |
Content-Type
|
string |
|
|
RESPONSES
status
curl -X PATCH 'https://api.zoom.us/v2/phone/users/:userId/settings/:settingType' -H 'Content-Type: application/json' -d '{"delegation":{"privacy":"\u003cboolean\u003e","privileges":3,"locked":"\u003cboolean\u003e"},"desk_phone":{"devices":[{"id":"\u003cstring\u003e","policy":{"call_control":{"status":"off"},"hot_desking":{"status":"off"}}},{"id":"\u003cstring\u003e","policy":{"call_control":{"status":"on"},"hot_desking":{"status":"on"}}}],"phone_screen_lock":"\u003cboolean\u003e","pin_code":"\u003cstring\u003e"},"voice_mail":{"access_user_id":"\u003cstring\u003e","delete":"\u003cboolean\u003e","download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},"intercom":{"extension_id":"\u003cstring\u003e","device_id":"\u003cstring\u003e"},"voicemail_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}],"auto_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}],"ad_hoc_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}]}'