Update dial rule in admin-only dial plan

Testing

PUT

/dialplans/{dialplan}/dialrules/{dialrule}

Last modified:2026-09-26 06:29:39

OperationId:UpdateAdminOnlyDialrule

Updates a dial rule's routing: its application, parameter, destination, caller ID translation, enabled state, or description.

Send only the fields to change; the others keep their current values. The match fields (dial-rule-matching-*) make up the dialrule id, so this endpoint cannot change them and ignores any in the body. To change what a rule matches, delete it and create a new one.

The response is 202: the change is published and applied within a few seconds, so a read straight after it may not show the change yet. An unknown dialrule id returns 404.

This is the admin-only form of the endpoint, for the platform-shared dial plans whose domain is admin-only. Requires Super User scope. Super User Read Only can use GET; every other scope gets 403. The server sets domain to admin-only itself. For a plan that belongs to a domain, use the /domains/{domain}/dialplans/... form.

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 published and applied within a few seconds.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/dialplans/DID Table/dialrules/c2lwOjYxMUAq' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "dial-rule-translation-destination-user": "2600",
    "dial-rule-description": "611 - Support queue"
}'

Response Example

202 - Change destination

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

Modified at 2026-09-26 06:29:39

Read dial rule in admin-only dial plan

Delete dial rule in admin-only dial plan