Issues using /phone/setting_templates API with common area templates

I’m seeing issues using the Phone Setting Template API to GET and UPDATE common area templates. I’m wondering if this is a known issue or if I’m doing something wrong (I’m fairly new to the phone API).

GET Issue

The response to a GET request for a common area template that was created through the web portal does not include any policy, profile or user_settings data. It is also missing the ‘type’ property.

To reproduce

Create a common area template in the Zoom web portal (under Company Info → [Site Name] → Settings → Templates)

On the Profile tab, set the area code and change the timezone

Issue a get /phone/setting_templates?site_id={siteId} and parse the response for the new template’s ID

Issue a get /phone/setting_templates/{templateId}

Response:

 {
    "description": "",
    "name": "Test Common Area Template",
    "policy": {
        "ad_hoc_call_recording": {},
        "auto_call_recording": {},
        "call_forwarding": {},
        "call_overflow": {},
        "sms": {},
        "voicemail": {}
    },
    "profile": {},
    "user_settings": {
        "call_handling": {
            "business_hours": {
                "busy_connect_operator": {
                    "external_number": {}
                },
                "connect_to_operator": {
                    "external_number": {}
                }
            },
            "close_hours": {
                "busy_connect_operator": {
                    "external_number": {}
                },
                "connect_to_operator": {
                    "external_number": {}
                }
            }
        },
        "desk_phone": {}
    }
}

This only seems to apply to templates created in the web portal. If I create a template through the API, the response is complete.

UPDATE Issue

Updating a common area template changes the type to ‘user’ and the template details can no longer be accessed in the web portal.

To reproduce

Issue a post /phone/setting_templates to create a new template with body:

{
    "name": "Test Common Area Template"
    "description": "Test Common Area template",
    "type": "commonArea",
    "site_id": "{siteId}",
}

Issue a Issue a get /phone/setting_templates/{templateId} and verify type is ‘commonArea’

{
    "description": "Test Common Area Template",
    "name": "Test Common Area Template",
    "profile": {
        "area_code": "",
        "country": "US"
    },
    "type": "commonArea"
}

Issue a patch /phone/setting_templates/{templateId} request with the following body:

{"description": "Updated Common Area Template", "profile": {"country": "US", "area_code": "715"}}

Issue a get /phone/setting_templates/{templateId} and note the type is now ‘user’

{
    "description": "Updated Common Area Template",
    "name": "Test Common Area Template",
    "profile": {
        "area_code": "715",
        "country": "US"
    },
    "type": "user"
}

Browse to the template in the Zoom portal and click to open details. Results in ‘Internal Error, error code -1’ alert message.

I get the same result if I include type: "commonArea" in the update body.

This issue occurs with templates created through the Zoom portal or through the API.

I do not see either issue with user templates. I do not see the GET issue with autoReceptionist templates. I have not tried updating an autoReceptionist template.

Let me know if you need any other information.

Thanks

Hi @kris.seraphine
Thank you for reaching out to the Zoom Developer Forum and welcome to our community!
I am happy to help here!
Allow me some time to reproduce these steps on my end and I will come back with an update shortly
Best,
Elisa

Thanks! Please let me know if you need any additional information.

Hi @kris.seraphine
Thank you for your patience while I took a closer look to this issue.
This is a strange behavior since and I do not think the template type should be changing when updating the template (especially is you are not passing the field type in your request).

Unfortunately I am not able to replicate this issue on my end but I will reach out to you via Direct Message to follow up.

Best,
Elisa