This API 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 - only include the fields you want to change.
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
HTTP Request
PUT
https://api.vobiz.ai/api/v1/account/{account_id}/origination-uris/{uri_id}Authentication Required:
- • X-Auth-ID: Your account ID (e.g., {Auth_ID})
- • X-Auth-Token: Your account Auth Token
- • Content-Type: application/json
Request Parameters
All parameters are optional. Only include fields you want to update.
Request Parameters
| Name | Type | Description |
|---|---|---|
uri | string | Updated SIP URI destination in format sip:user@host:port or sip:host:port. Must be a valid, reachable SIP endpoint. |
priority | integer | Updated routing priority (lower = higher priority). Change to promote/demote URIs in failover hierarchy. |
weight | integer | Updated load balancing weight. Adjust to rebalance traffic distribution among same-priority URIs. |
enabled | boolean | Updated active status. Set to false to temporarily disable without deleting. |
Response
Returns the complete updated origination URI object with the new values and an updated timestamp.
Response - 200 OK
{
"id": "e1f2a3b4-c5d6-7890-efab-567890123456",
"uri": "sip:updated@sip.example.com:5060",
"priority": 2,
"weight": 20,
"enabled": false,
"created_at": "2025-01-15T10:45:30Z",
"updated_at": "2025-01-22T12:30:45Z"
}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/e1f2a3b4-c5d6-7890-efab-567890123456 \
-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/e1f2a3b4-c5d6-7890-efab-567890123456 \
-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/e1f2a3b4-c5d6-7890-efab-567890123456 \
-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/e1f2a3b4-c5d6-7890-efab-567890123456 \
-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/e1f2a3b4-c5d6-7890-efab-567890123456 \
-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