Update connection

PUT

/connections/{connection-id}

Last modified:2026-09-26 20:52:15

OperationId:updateConnection

Changes a connection by connection-id, without naming its domain. Requires Super User or Reseller scope. A Reseller can change only a connection in its own territory; other scopes use PUT /domains/{domain}/connections/{connection-id}. The API publishes the change on the service bus (SBUS) connection_events channel, and each server applies it when the event arrives, so 202 means published, not applied.

The path identifies the connection. A domain or connection-orig-match-pattern in the body is ignored, so the key cannot be renamed. An id that names no connection, or one outside your territory, returns 404. A route profile's id keeps its route-name address and its route_profile type: a different connection-connectivity-type returns 400, and a different connection-address is ignored with a Warning header. Send only what changes. Omitted fields keep their stored values, the call-processing fields such as connection-sip-transport-protocol included. Changing connection-connectivity-type also sets connection-sip-authenticate-as-client-enabled and reformats connection-address to suit the type. An invalid connection-connectivity-type, connection-require-encrypted-audio-enabled, or connection-sip-session-timer-enabled returns 400. Sending call-routing returns 404: change a route profile's route through the route-profile endpoints. synchronous is ignored.

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/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change was published on the SBUS. It is applied after this response.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

Change descriptionSwitch to TLSLimit calls

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/connections/c2lwOipAMTkyLjAuMi4xMA' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "description": "Carrier trunk 1, primary"
}'

Response Example

202 - Change description

Published.

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

Modified at 2026-09-26 20:52:15

Read connection

Delete connection