Logo
Zoom Public API Documentation

Add a user's shared access setting

POST {{baseUrl}}/phone/users/:userId/settings/:settingType

Adds 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:write:shared_setting,phone:write:shared_setting:admin

Rate Limit Label: Light

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status Created

{ "delegation": { "assistants": [ { "display_name": "<string>", "extension_id": "<string>", "extension_number": "<long>", "extension_type": "<string>", "id": "<string>" }, { "display_name": "<string>", "extension_id": "<string>", "extension_number": "<long>", "extension_type": "<string>", "id": "<string>" } ], "privacy": "<boolean>", "privileges": 2 }, "voice_mail": { "access_user_id": "<string>", "delete": "<boolean>", "download": "<boolean>", "shared_id": "<string>" }, "voicemail_access_members": [ { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "allow_sharing": "<boolean>", "shared_id": "<string>" }, { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "allow_sharing": "<boolean>", "shared_id": "<string>" } ], "auto_call_recording_access_members": [ { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "shared_id": "<string>" }, { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "shared_id": "<string>" } ], "ad_hoc_call_recording_access_members": [ { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "shared_id": "<string>" }, { "access_user_id": "<string>", "allow_delete": "<boolean>", "allow_download": "<boolean>", "shared_id": "<string>" } ] }



Curl
curl -X POST 'https://api.zoom.us/v2/phone/users/:userId/settings/:settingType' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"delegation_assistant_extension_id":"\u003cstring\u003e","device_id":"\u003cstring\u003e","voice_mail":{"access_user_id":"\u003cstring\u003e","delete":"\u003cboolean\u003e","download":"\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"}],"auto_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e"}],"ad_hoc_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e"}]}'

ENDPOINTS