PATCH /phone/shared_line_groups/{sharedLineGroupId}
A shared line group allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to update information of a Shared Line Group.
Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:write:admin
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
sharedLineGroupId |
String | Yes |
Unique identifier of the shared line group that is to be updated. |
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 assigned to the Shared Line Group. |
timezone |
String | No |
Timezone to be used for the Business Hours. A value should be provided from the IDs listed here. |
display_name |
String | No |
Display Name of the Shared Line Group. |
primary_number |
Object | No |
If you have multiple direct phone numbers assigned to the shared line group, select a number from those numbers as the primary number. The primary number shares the same line as the extension number. This means if a caller is routed to the shared line group through an auto receptionist, the line associated with the primary number will be used. A pending number cannot be used as a Primary Number. |
primary_number.id |
String | No |
Phone Number ID. Unique Identifier of the Phone Number. |
primary_number.number |
String | No |
Phone Number that you would like to assign as the primary number for this Shared Line Group. |
status |
String | No |
Status of the Shared Line Group. Valid values:
|
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.