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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

All parameters are optional. Only include fields you want to update.
FieldTypeRequiredDescription
uristringNoUpdated SIP URI destination in the format sip:user@host:port or sip:host:port. Must be a valid, reachable SIP endpoint.
priorityintegerNoUpdated routing priority (lower = higher priority). Adjust to promote or demote URIs in the failover hierarchy.
weightintegerNoUpdated load balancing weight. Adjust to rebalance traffic distribution among same-priority URIs.
enabledbooleanNoUpdated active status. Set to false to temporarily disable without deleting.

​
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": "",
  "uri": "sip:sbc1.example.com:5060",
  "priority": 2,
  "weight": 10,
  "enabled": true,
  "transport": "TCP",
  "description": "",
  "created_at": "2026-05-12T05:11:51.914686Z",
  "updated_at": "2026-05-12T05:11:51.964357Z"
}

​
Examples

​
cURL - Change Priority for Failover

Promote a backup URI (priority 2) to primary (priority 1):
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 '{
    "priority": 1
  }'

​
cURL - Adjust Load Balancing Weight

Increase weight to shift more traffic to this URI:
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 '{
    "weight": 50
  }'

​
cURL - Update SIP Destination

Change the URI to point to a different carrier or server:
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 '{
    "uri": "sip:newcarrier@sip.newprovider.com:5060"
  }'

​
cURL - Temporarily Disable URI

Disable URI for maintenance without deleting it:
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 '{
    "enabled": false
  }'

​
cURL - Multiple Updates

Update multiple fields in a single request:
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 '{
    "uri": "sip:updated@sip.example.com:5060",
    "priority": 1,
    "weight": 30,
    "enabled": true
  }'
Failover Strategy Example:
  • If primary carrier fails, update priority from 2 to 1 to promote backup to primary
  • After carrier maintenance, restore original priority settings
  • Use enabled: false during planned maintenance instead of changing priorities
  • Test connectivity before re-enabling URIs after maintenance

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