Skip to main content
PUT
Update a trunk
Use this endpoint to update the configuration of an existing trunk. You can modify the name, description, and rate limits. Include only the fields you want to update; other fields will remain unchanged.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Note: trunk_id and auth_id cannot be changed after creation.

Request Parameters

Send all three fields on every update - this is a replace, not a partial patch. To keep a value unchanged, resend its current value (fetch it first with Retrieve a Trunk).

Examples

Response

Returns the complete trunk object with updated values and a new updated_at timestamp.
Response - 200 OK
Best Practice: Disable a trunk instead of deleting it if you might need the configuration later. Disabled trunks do not handle calls but preserve all settings, credentials, and routing rules.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

trunk_id
string
required

Body

application/json

All fields are optional - send only what you want to change. Does not accept username/password (rotate credentials via the credentials subresource endpoint).

name
string
Maximum string length: 100
trunk_direction
enum<string>

Direction of the trunk - inbound or outbound only.

Available options:
inbound,
outbound
trunk_status
enum<string>
Available options:
enabled,
disabled
secure
boolean
trunk_domain
string
Maximum string length: 255
transport
enum<string>
Available options:
udp,
tcp,
tls
inbound_destination
string
Maximum string length: 255
description
string
Maximum string length: 500
concurrent_calls_limit
integer
Required range: 0 <= x <= 1000
cps_limit
integer
Required range: 0 <= x <= 100
credential_uuid
string
ipacl_uuid
string
primary_uri_uuid
string
fallback_uri_uuid
string
recording
boolean
enable_transcription
boolean
pii_redaction
boolean
pii_entity_types
string
webhook_url
string

Customer webhook for call-admission events (CallInitiated / Hangup). Public http/https URL; SSRF-validated. See Trunk Webhooks.

Maximum string length: 500
webhook_method
enum<string>
default:POST
Available options:
POST,
GET
recording_webhook_enabled
boolean

Response

200 - application/json

Trunk updated

trunk_id
string
required
account_id
string
required
name
string
required
trunk_domain
string
required
trunk_status
string
required
secure
boolean
required
trunk_direction
string
required
concurrent_calls_limit
integer
required
cps_limit
integer
required
description
string
required
transport
string
required
recording
boolean
required
enable_transcription
boolean
required
pii_redaction
boolean
required
webhook_method
string
required
recording_webhook_enabled
boolean
required
created_at
string
required
updated_at
string
required