Skip to main content

Update an External Connection

PATCH 
/external_connections/:id

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

Request

Path Parameters

    id int64required

    Identifies the resource.

Body

required

Parameters to be updated for the External Connection

    active Connection Active (boolean)

    Default value: true

    Specifies whether the connection can be used.

    webhook_event_url url

    The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

    webhook_event_failover_url urlnullable

    The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

    webhook_timeout_secs integernullable

    Possible values: <= 30

    Specifies how many seconds to wait before timing out a webhook.

    inbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

    outbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

    outbound_voice_profile_id int64

    Identifies the associated outbound voice profile.

Responses

200: Successful response

401: Unauthorized

404: Resource not found

422: Bad request

Request samples


curl -L -X PATCH 'https://api.telnyx.com/v2/external_connections/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"active": false,
"outbound": {
"outbound_voice_profile_id": "1911630617284445511"
}
}'

Response samples


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