Skip to main content
PUT
/
api
/
v1
/
Account
/
{auth_id}
/
origination-uris
/
{uri_id}
Update an origination URI
curl --request PUT \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "priority": 123
}
'
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "uri": "sip:sbc1.example.com",
  "priority": 2,
  "weight": 10,
  "enabled": true,
  "transport": "TCP",
  "description": "Primary SBC",
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T11:30:00Z"
}
PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id}
Updates an existing origination URI. You can modify the SIP destination, adjust priority and weight for routing optimization, or enable/disable the URI without deleting it. All fields are optional - include only the fields you want to change.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Common Use Cases:
  • Change URI priority to implement failover strategies or promote a backup URI to primary
  • Adjust weights to rebalance traffic distribution across multiple carriers
  • Update the SIP destination when switching carriers or changing server addresses
  • Temporarily disable a URI (enabled: false) without deleting it for maintenance windows

Request Parameters

Send both fields on every update - this is a replace, not a partial patch. To keep the current label, resend it.
FieldTypeRequiredDescription
namestringYesLabel for the destination. Surfaces as description on the returned object.
priorityintegerYesRouting priority (lower = higher priority). Adjust to promote or demote a URI in the failover hierarchy.
What this endpoint cannot change. The SIP destination (uri), weight, and enabled are not part of the update body. To point at a different carrier or host, delete the URI and create a new one. To rebalance weight or toggle enabled, use the Console.

Response

Returns the complete origination URI object with updated values and a new updated_at timestamp.
Response - 200 OK
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "uri": "sip:provider@sip.example.com:5060",
  "priority": 1,
  "weight": 10,
  "enabled": true,
  "transport": "udp",
  "description": "Primary SBC",
  "created_at": "2026-05-12T05:11:51.914686Z",
  "updated_at": "2026-05-12T05:11:51.964357Z"
}

Examples

cURL - Promote a backup to primary

Change a backup URI from priority 2 to priority 1 (resend its name):
cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/aabbccdd-1234-5678-90ab-cdef12345678 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Backup SBC",
    "priority": 1
  }'

cURL - Demote a primary to failover

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/aabbccdd-1234-5678-90ab-cdef12345678 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Primary SBC",
    "priority": 3
  }'
Failover Strategy:
  • Promote a backup to primary by lowering its priority to 1, then raise the failed carrier’s number so it becomes the fallback.
  • To switch SIP destinations entirely, create the new URI first, confirm calls route through it, then delete the old one.

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"

uri_id
string
required

Body

application/json
name
string
required
priority
integer
required

Response

200 - application/json

Origination URI updated

id
string
required
account_id
string
required
uri
string
required
priority
integer
required
weight
integer
required
enabled
boolean
required
transport
string
required
description
string
required
created_at
string
required
updated_at
string
required