PATCH /phone/common_area_phones/{commonAreaPhoneId}
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to update details on a specific common area phone in an account.
Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Supported device
Scopes:phone:write:admin
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
commonAreaPhoneId |
String | Yes |
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 |
|---|---|---|---|
extension_number |
Integer | No |
Extension number of the phone. If site code is enabled, provide short extension number instead. |
site_id |
String | No |
Unique identifier of the site to which the common area desk phone is assigned. |
display_name |
String | No |
Display name of the common area phone. |
mac_address |
String | No |
Mac address or serial number of the device. Examples of supported format: "64-16-7f-37-90-92" or "64167f379092". |
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.