---
title: "Update a credential connection"
method: PATCH
path: "/credential_connections/{id}"
tags: ["Credential Connections"]
---

# Update a credential connection

`PATCH /credential_connections/{id}`

Updates settings of an existing credential connection.

## Path parameters

- `id` string, required

## Request body

- UpdateCredentialConnectionRequest
  - `active` boolean — Defaults to true
  - `user_name` string — The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).
  - `password` string — The password to be used as part of the credentials. Must be 8 to 128 characters long.
  - `anchorsite_override` 'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany' — `Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
  - `connection_name` string — A user-assigned name to help manage the connection.
  - `sip_uri_calling_preference` 'disabled' | 'unrestricted' | 'internal' — This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
  - `default_on_hold_comfort_noise_enabled` boolean — When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
  - `dtmf_type` 'RFC 2833' | 'Inband' | 'SIP INFO' — Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
  - `encode_contact_header_enabled` boolean — Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
  - `encrypted_media` 'SRTP' | 'null', nullable — Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
  - `onnet_t38_passthrough_enabled` boolean — Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
  - `ios_push_credential_id` string, nullable — The uuid of the push credential for Ios
  - `android_push_credential_id` string, nullable — The uuid of the push credential for Android
  - `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.
  - `call_cost_in_webhooks` boolean — Specifies if call cost webhooks should be sent for this connection.
  - `tags` string[] — Tags associated with the connection.
  - `rtcp_settings` ConnectionRtcpSettings
    - `port` 'rtcp-mux' | 'rtp+1' — RTCP port by default is rtp+1, it can also be set to rtcp-mux
    - `capture_enabled` boolean — BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.
    - `report_frequency_secs` integer — RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.
  - `inbound` CredentialInbound
    - `ani_number_format` '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national' — This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
    - `dnis_number_format` '+e164' | 'e164' | 'national' | 'sip_username'
    - `codecs` string[] — Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.
    - `default_routing_method` 'sequential' | 'round-robin' — Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.
    - `channel_limit` integer — When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
    - `generate_ringback_tone` boolean — Generate ringback tone through 183 session progress message with early media.
    - `isup_headers_enabled` boolean — When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
    - `prack_enabled` boolean — Enable PRACK messages as defined in RFC3262.
    - `sip_compact_headers_enabled` boolean — Defaults to true.
    - `timeout_1xx_secs` integer — Time(sec) before aborting if connection is not made.
    - `timeout_2xx_secs` integer — Time(sec) before aborting if call is unanswered (min: 1, max: 600).
    - `shaken_stir_enabled` boolean — When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.
    - `simultaneous_ringing` 'disabled' | 'enabled' — When enabled, allows multiple devices to ring simultaneously on incoming calls.
  - `outbound` CredentialOutbound
    - `call_parking_enabled` boolean, nullable — Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
    - `ani_override` string — Set a phone number as the ani_override value to override caller id number on outbound calls.
    - `ani_override_type` 'always' | 'normal' | 'emergency' — Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.
    - `channel_limit` integer — When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
    - `instant_ringback_enabled` boolean — When set, ringback will not wait for indication before sending ringback tone to calling party.
    - `generate_ringback_tone` boolean — Generate ringback tone through 183 session progress message with early media.
    - `localization` string — A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.
    - `t38_reinvite_source` 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru' — This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.
    - `outbound_voice_profile_id` string — Identifies the associated outbound voice profile.
  - `noise_suppression` 'inbound' | 'outbound' | 'both' | 'disabled' — Controls when noise suppression is applied to calls. When set to 'inbound', noise suppression is applied to incoming audio. When set to 'outbound', it's applied to outgoing audio. When set to 'both', it's applied in both directions. When set to 'disabled', noise suppression is turned off.
  - `noise_suppression_details` ConnectionNoiseSuppressionDetails — Configuration options for noise suppression. These settings are stored regardless of the noise_suppression value, but only take effect when noise_suppression is not 'disabled'. If you disable noise suppression and later re-enable it, the previously configured settings will be used.
    - `engine` 'denoiser' | 'deep_filter_net' | 'deep_filter_net_large' | 'krisp_viva_tel' | 'krisp_viva_tel_lite' | 'krisp_viva_promodel' | 'krisp_viva_ss' | 'quail_voice_focus' — The noise suppression engine to use. 'denoiser' is the default engine. 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with different performance characteristics. Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced noise suppression capabilities. 'quail_voice_focus' provides Quail-based voice focus noise suppression.
    - `attenuation_limit` integer — The attenuation limit value for the selected engine. Default values vary by engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss'), 100 for 'quail_voice_focus'.
  - `jitter_buffer` ConnectionJitterBuffer — Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled. You may define min and max values in msec for customized buffering behaviors. Larger values add latency but tolerate more jitter, while smaller values reduce latency but are more sensitive to jitter and reordering.
    - `enable_jitter_buffer` boolean — Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled.
    - `jitterbuffer_msec_min` integer — The minimum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
    - `jitterbuffer_msec_max` integer — The maximum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.

## Response `200`

Successful response with details about a credential connection.

- object
  - `data` CredentialConnection
    - `id` string — Identifies the type of resource.
    - `record_type` string — Identifies the type of the resource.
    - `active` boolean — Defaults to true
    - `user_name` string — The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). At least one of the first 5 characters must be a letter.
    - `password` string — The password to be used as part of the credentials. Must be 8 to 128 characters long.
    - `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.
    - `anchorsite_override` 'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany' — `Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
    - `connection_name` string
    - `sip_uri_calling_preference` 'disabled' | 'unrestricted' | 'internal' — This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
    - `default_on_hold_comfort_noise_enabled` boolean — When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
    - `dtmf_type` 'RFC 2833' | 'Inband' | 'SIP INFO' — Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
    - `encode_contact_header_enabled` boolean — Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
    - `encrypted_media` 'SRTP' | 'null', nullable — Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
    - `onnet_t38_passthrough_enabled` boolean — Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
    - `ios_push_credential_id` string, nullable — The uuid of the push credential for Ios
    - `android_push_credential_id` string, nullable — The uuid of the push credential for Android
    - `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.
    - `call_cost_in_webhooks` boolean — Specifies if call cost webhooks should be sent for this connection.
    - `tags` string[] — Tags associated with the connection.
    - `rtcp_settings` ConnectionRtcpSettings
      - `port` 'rtcp-mux' | 'rtp+1' — RTCP port by default is rtp+1, it can also be set to rtcp-mux
      - `capture_enabled` boolean — BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.
      - `report_frequency_secs` integer — RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.
    - `inbound` CredentialInbound
      - `ani_number_format` '+E.164' | 'E.164' | '+E.164-national' | 'E.164-national' — This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
      - `dnis_number_format` '+e164' | 'e164' | 'national' | 'sip_username'
      - `codecs` string[] — Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.
      - `default_routing_method` 'sequential' | 'round-robin' — Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.
      - `channel_limit` integer — When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
      - `generate_ringback_tone` boolean — Generate ringback tone through 183 session progress message with early media.
      - `isup_headers_enabled` boolean — When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
      - `prack_enabled` boolean — Enable PRACK messages as defined in RFC3262.
      - `sip_compact_headers_enabled` boolean — Defaults to true.
      - `timeout_1xx_secs` integer — Time(sec) before aborting if connection is not made.
      - `timeout_2xx_secs` integer — Time(sec) before aborting if call is unanswered (min: 1, max: 600).
      - `shaken_stir_enabled` boolean — When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.
      - `simultaneous_ringing` 'disabled' | 'enabled' — When enabled, allows multiple devices to ring simultaneously on incoming calls.
    - `outbound` CredentialOutbound
      - `call_parking_enabled` boolean, nullable — Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
      - `ani_override` string — Set a phone number as the ani_override value to override caller id number on outbound calls.
      - `ani_override_type` 'always' | 'normal' | 'emergency' — Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.
      - `channel_limit` integer — When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
      - `instant_ringback_enabled` boolean — When set, ringback will not wait for indication before sending ringback tone to calling party.
      - `generate_ringback_tone` boolean — Generate ringback tone through 183 session progress message with early media.
      - `localization` string — A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.
      - `t38_reinvite_source` 'telnyx' | 'customer' | 'disabled' | 'passthru' | 'caller-passthru' | 'callee-passthru' — This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.
      - `outbound_voice_profile_id` string — Identifies the associated outbound voice profile.
    - `noise_suppression` 'inbound' | 'outbound' | 'both' | 'disabled' — Controls when noise suppression is applied to calls. When set to 'inbound', noise suppression is applied to incoming audio. When set to 'outbound', it's applied to outgoing audio. When set to 'both', it's applied in both directions. When set to 'disabled', noise suppression is turned off.
    - `noise_suppression_details` ConnectionNoiseSuppressionDetails — Configuration options for noise suppression. These settings are stored regardless of the noise_suppression value, but only take effect when noise_suppression is not 'disabled'. If you disable noise suppression and later re-enable it, the previously configured settings will be used.
      - `engine` 'denoiser' | 'deep_filter_net' | 'deep_filter_net_large' | 'krisp_viva_tel' | 'krisp_viva_tel_lite' | 'krisp_viva_promodel' | 'krisp_viva_ss' | 'quail_voice_focus' — The noise suppression engine to use. 'denoiser' is the default engine. 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with different performance characteristics. Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced noise suppression capabilities. 'quail_voice_focus' provides Quail-based voice focus noise suppression.
      - `attenuation_limit` integer — The attenuation limit value for the selected engine. Default values vary by engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss'), 100 for 'quail_voice_focus'.
    - `jitter_buffer` ConnectionJitterBuffer — Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled. You may define min and max values in msec for customized buffering behaviors. Larger values add latency but tolerate more jitter, while smaller values reduce latency but are more sensitive to jitter and reordering.
      - `enable_jitter_buffer` boolean — Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled.
      - `jitterbuffer_msec_min` integer — The minimum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
      - `jitterbuffer_msec_max` integer — The maximum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.

## Other responses

- `401` — Unauthorized
- `403` — The user doesn't have the required permissions to perform the requested action.
- `404` — The requested resource doesn't exist.
- `422` — The request was well-formed but was unable to be followed due to semantic errors.

---

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