Skip to main content
PATCH
Update an external trunk

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
phone_number
string
required

Identifier for the trunk being updated. Together with channel, locates exactly one trunk row. Not editable — the value here must match the existing trunk.

Example:

"+12345678901"

channel
enum<string>
required

Identifier for the trunk being updated. Not editable — to move a number to a different channel, delete and recreate.

Available options:
call,
whatsapp
name
string

Friendly label for the trunk. Surfaces in dashboards. Pass to rename; omit to keep the existing label.

direction
enum<string>

Call-channel only. Whether this trunk handles inbound, outbound, or both. Ignored on WhatsApp.

Available options:
inbound,
outbound,
both
sip
object

SIP credentials. Only the keys you provide are touched — other credentials remain unchanged. Pass an empty string for any field to clear it.

additional_settings
object

Free-form JSON stored on the binding. Replaces the existing object when provided; pass an empty object to clear.

Response

Updated

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

data
object

Per-channel snapshot returned by /phone-numbers/{uuid}/channels, /phone-numbers/channels?number=…, and the trunk create/update/assign endpoints. Combines capability (what the carrier supports), state (what's enabled), and binding (which agent is wired up).