Update a Pay connector
Update a generic connector by name in the authenticated organization. Both test and live connectors can be updated through the API. Omitted fields remain unchanged. Supplying config replaces the entire config; it does not merge keys. Include endpoint_url and the credentials required for the selected auth_type on every config replacement. Omitting config preserves existing credentials, allowing a mode-only update. The path name cannot be renamed. Public updates use PATCH.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const PayConnector = await client.payConnectors.update('name', {
type: 'generic',
});
console.log(PayConnector.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
pay_connector = client.pay_connectors.update(
name="name",
type="generic",
)
print(pay_connector.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
payConnector, err := client.PayConnectors.Update(
context.TODO(),
"name",
telnyx.PayConnectorUpdateParams{
Type: telnyx.String("generic"),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", payConnector.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.payConnectors.PayConnectorUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PayConnectorUpdateParams params = PayConnectorUpdateParams.builder()
.type(PayConnectorUpdateParams.Type.GENERIC)
.build();
var response = client.payConnectors().update("name", params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
pay_connector = telnyx.pay_connectors.update("name", type: :generic)
puts(pay_connector)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$pay_connector = $client->payConnectors->update(
'name',
type: 'generic',
);
var_dump($pay_connector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx pay-connectors update \
--api-key 'My API Key' \
--name my-payment-connector \
--type genericcurl --request PATCH \
--url https://api.telnyx.com/v2/pay_connectors/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"mode": "live"
}'{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"record_type": "pay_connector",
"name": "my-payment-connector",
"type": "generic",
"mode": "live",
"user_id": "user-example",
"organization_id": "organization-example",
"config": {
"endpoint_url": "https://processor.example.com/pay",
"auth_type": "bearer"
},
"created_at": "2026-10-01T12:00:00.000000Z",
"updated_at": "2026-10-01T12:00:00.000000Z"
}
}{
"errors": [
{
"detail": "Resource not found"
}
]
}{
"errors": [
{
"code": "10000",
"title": "Invalid request",
"detail": "The 'config' parameter is invalid. Please consult the documentation.",
"source": {
"pointer": "/config"
}
}
]
}Authorizations
Telnyx API key, not the processor bearer token.
Path Parameters
Connector name, not its UUID. URL-encode the name as a path segment.
"my-payment-connector"
Body
Only type, mode and config are updated; the connector name is selected by the path. Omit config to preserve existing configuration and credentials. If supplied, send the entire replacement config including required credentials.
Generic connector type. Omit to preserve the existing value.
generic Omit to preserve the existing mode. Use an explicit test or live value.
test, live Configuration for a generic connector. A config update replaces the complete object, not individual keys. Unknown config keys are discarded. Authentication credentials must be nonblank strings when required by the selected auth_type.
- Basic authentication (also the validation default)
- Bearer authentication
- No processor authentication
Show child attributes
Show child attributes
Response
Updated connector after the modeOnly example, with credentials omitted.
Organization-owned connector. Examples and config properties here describe generic connectors; listing is not restricted to that type unless filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not masked. Defaults for auth_type and timeout need not appear in stored config.
Show child attributes
Show child attributes
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const PayConnector = await client.payConnectors.update('name', {
type: 'generic',
});
console.log(PayConnector.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
pay_connector = client.pay_connectors.update(
name="name",
type="generic",
)
print(pay_connector.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
payConnector, err := client.PayConnectors.Update(
context.TODO(),
"name",
telnyx.PayConnectorUpdateParams{
Type: telnyx.String("generic"),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", payConnector.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.payConnectors.PayConnectorUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PayConnectorUpdateParams params = PayConnectorUpdateParams.builder()
.type(PayConnectorUpdateParams.Type.GENERIC)
.build();
var response = client.payConnectors().update("name", params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
pay_connector = telnyx.pay_connectors.update("name", type: :generic)
puts(pay_connector)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$pay_connector = $client->payConnectors->update(
'name',
type: 'generic',
);
var_dump($pay_connector);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx pay-connectors update \
--api-key 'My API Key' \
--name my-payment-connector \
--type genericcurl --request PATCH \
--url https://api.telnyx.com/v2/pay_connectors/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"mode": "live"
}'{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"record_type": "pay_connector",
"name": "my-payment-connector",
"type": "generic",
"mode": "live",
"user_id": "user-example",
"organization_id": "organization-example",
"config": {
"endpoint_url": "https://processor.example.com/pay",
"auth_type": "bearer"
},
"created_at": "2026-10-01T12:00:00.000000Z",
"updated_at": "2026-10-01T12:00:00.000000Z"
}
}{
"errors": [
{
"detail": "Resource not found"
}
]
}{
"errors": [
{
"code": "10000",
"title": "Invalid request",
"detail": "The 'config' parameter is invalid. Please consult the documentation.",
"source": {
"pointer": "/config"
}
}
]
}