Update phone template

PUT

/domains/{domain}/phonetemplates/{name}

Last modified:2026-10-09 00:48:37

OperationId:UpdatePhoneTemplateDomain

Changes a phone template in the domain. The path names the template. Fields you leave out keep their values, except the buttons.

phoneconfiguration-buttons replaces the whole button list. Send every button on each update: an update without phoneconfiguration-buttons deletes every button. Every button you send is saved, and the buttons belong to this configuration in this domain only. The button types and features a model supports come from GET /deviceprofiles/{brand}/{model}, in devicemodel.

Two button features also write a dial rule. It goes in the dial plan of the user on the first line button, or in the domain's dial plan when there is no line button. A queue_status button toggles the user's call queue availability: its target is ignored, and reads return it empty. A timeframe_status button toggles a time frame: its target is the time frame name, and Default means the default time frame. Add targetUser to the button's phoneconfiguration-extra to toggle another user's time frame. The dial rules appear with the dial plan's other dial rules.

phoneconfiguration-domain in the body is ignored: the domain comes from the path. Platform-wide templates cannot be changed. Returns 404 when the domain has no template with this name. A 202 means the change is accepted and already applied.

Requires Office Manager scope or above for your own domain, Reseller scope for the domains in your territory, or Super User scope.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

The change is accepted and already applied.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//phonetemplates/Front%20Desk%20WP826' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "phoneconfiguration-description": "Front desk layout, queue toggle locked",
    "phoneconfiguration-brand": "Grandstream",
    "phoneconfiguration-model": "WP826",
    "phoneconfiguration-buttons": [
        {
            "phoneconfiguration-button-order": 1,
            "phoneconfiguration-button-type": "line_only",
            "phoneconfiguration-button-feature": "line",
            "phoneconfiguration-button-target": "1001",
            "phoneconfiguration-button-label": "Line 1",
            "phoneconfiguration-button-locked": 0,
            "phoneconfiguration-extra": {}
        },
        {
            "phoneconfiguration-button-order": 2,
            "phoneconfiguration-button-type": "line_only",
            "phoneconfiguration-button-feature": "line",
            "phoneconfiguration-button-target": "1001",
            "phoneconfiguration-button-label": "Line 2",
            "phoneconfiguration-button-locked": 0,
            "phoneconfiguration-extra": {}
        },
        {
            "phoneconfiguration-button-order": 4,
            "phoneconfiguration-button-type": "mpk",
            "phoneconfiguration-button-feature": "queue_status",
            "phoneconfiguration-button-target": "",
            "phoneconfiguration-button-label": "Queue",
            "phoneconfiguration-button-locked": 1,
            "phoneconfiguration-extra": {}
        }
    ]
}'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-09 00:48:37

Create phone template

Delete phone template