Logo
Zoom Public API Documentation

phone-common_areas-{commonAreaId}-settings-{settingType}

Number of APIs: 3


1. Add common area settings

POST {{baseUrl}}/phone/common_areas/:commonAreaId/settings/:settingType

Use this API to add the common area setting according to the setting type, specifically for desk phones.

Note: For use by customers who opted for Common Area Optimization

Prerequisites: * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions.

Scopes: phone:write:admin

Granular Scopes: phone:write:common_area_setting:admin

Rate Limit Label: Light



2. Update common area settings

PATCH {{baseUrl}}/phone/common_areas/:commonAreaId/settings/:settingType

Use this API to update the common area setting according to the setting type, specifically for desk phones.

Note: For use by customers who opted for Common Area Optimization

Prerequisites: * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions.

Scopes: phone:write:admin

Granular Scopes: phone:update:common_area_setting:admin

Rate Limit Label: Light



3. Delete common area setting

DELETE {{baseUrl}}/phone/common_areas/:commonAreaId/settings/:settingType?device_id=<string>

Use this API to remove the common area subsetting from desk phones.

Note: For use by customers who opted for Common Area Optimization

Prerequisites: * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions.

Scopes: phone:write:admin

Granular Scopes: phone:delete:common_area_setting:admin

Rate Limit Label: Light



ENDPOINTS