POST /phone/users/{userId}/settings/{settingType}
Phone users can access shared voicemail inboxes in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user.
To view these settings in the Zoom web portal, navigate to Admin >Phone System Management> Users & Rooms. Click the Users tab and select User Settings. Scroll down to Voicemail & Call Recordings.
Scope:phone:write:admin
**Rate Limit Label:** Light
Prerequisites:
Business or Enterprise Account
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Unique identifier of the user. |
settingType |
String | Yes |
Corresponds to the setting item you wish to modify. Allowed values: |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
voice_mail |
Object | No |
Update the voicemail setting. |
voice_mail.access_user_id |
String | No |
Specify the user ID of a user with whom to share voicemail access permissions. |
voice_mail.delete |
Boolean | No |
Specifies whether the user has delete permissions. The default is false. |
voice_mail.download |
Boolean | No |
Specifies whether the user has download permissions. The default is false. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.