---
title: "Update an External Connection"
method: PATCH
path: "/external_connections/{id}"
tags: ["External Connections"]
---

# Update an External Connection

`PATCH /external_connections/{id}`

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

## Path parameters

- `id` string, required

## Request body

- UpdateExternalConnectionRequest
  - `active` boolean — Specifies whether the connection can be used.
  - `webhook_event_url` string, uri — The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
  - `webhook_event_failover_url` string, uri, nullable — 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'.
  - `tags` string[] — Tags associated with the connection.
  - `webhook_timeout_secs` integer, nullable — 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, required
    - `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` string, required — Identifies the associated outbound voice profile.

## Response `200`

Successful response

- object
  - `data` ExternalConnection
    - `id` string — Uniquely identifies the resource.
    - `record_type` string — Identifies the type of the resource.
    - `active` boolean — Specifies whether the connection can be used.
    - `credential_active` boolean — If the credential associated with this service is active.
    - `external_sip_connection` 'zoom' | 'operator_connect' — The service that will be consuming this connection.
    - `tags` string[] — Tags associated with the connection.
    - `webhook_event_url` string, uri — The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
    - `webhook_event_failover_url` string, uri, nullable — 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_api_version` '1' | '2' — Determines which webhook format will be used, Telnyx API v1 or v2.
    - `webhook_timeout_secs` integer, nullable — 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` string — Identifies the associated outbound voice profile.
    - `created_at` string — ISO 8601 formatted date indicating when the resource was created.
    - `updated_at` string — ISO 8601 formatted date indicating when the resource was updated.

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `422` — Bad request

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)