Update route

PUT

/routes/{route-id}

Last modified:2026-09-26 18:00:25

OperationId:UpdateRoute

Changes a route's description, route-method, or route-is-enabled. Requires Super User scope. Other scopes, Reseller included, get 403. The API publishes the change on the service bus (SBUS) NmsRoute channel, and core applies it when the event arrives, so 202 means published, not applied.

route-id identifies the route. Its 4 match fields come from the path, and any in the body are ignored, so this cannot move a route to another pattern. To do that, create the new route and its connections, then delete the old one. A route-id that names no route returns 404.

Send synchronous=yes, in the body or the query string, to wait up to 2 seconds for the change to be applied. You then get 200 with the route. If it is not applied in time, you get the usual 202 and the write still completes.

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

🟢200OK

application/json

Returned for synchronous=yes once the change is applied: the route.

Bodyapplication/json

🟢202Accepted

🟠404

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

cURL

Switch to least costDisable

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/routes/c2lwOjE4MDAqQCo' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "description": "Toll-free outbound, least cost",
    "route-method": "cost"
}'

Response Example

200 - Disable

The route after the change.

{
    "route-destination-match-pattern": "sip:1800*@*",
    "route-source-match-pattern": "*",
    "route-class": "*",
    "route-match-server-hostname": "*",
    "route-is-enabled": "no",
    "description": "Toll-free outbound",
    "route-method": "cost",
    "route-id": "c2lwOjE4MDAqQCo"
}

Modified at 2026-09-26 18:00:25

Create route connection

Update route connection