Update an External Connection

PATCH

/external_connections/{id}

Updates settings of an existing External Connection based on the parameters of the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/external_connections/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "active": false,
    "outbound": {
        "outbound_voice_profile_id": "1911630617284445511"
    }
}'

Response Example

{
    "data": {
        "active": false,
        "created_at": "2022-06-29T19:23:59Z",
        "credential_active": false,
        "external_sip_connection": "zoom",
        "id": "1930241863466354012",
        "outbound": {
            "outbound_voice_profile_id": "1911630617284445511"
        },
        "record_type": "external_connection",
        "updated_at": "2022-06-29T19:39:47Z"
    }
}

Request

Authorization

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

Successful response

Body

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-06-16 19:14:41

Retrieve an External Connection

List all civic addresses and locations