Origination URI
Update Origination URI
Update a Vobiz origination URI - change SIP destination, routing priority, load-balancing weight, or enabled state with a partial PUT; no re-creation needed.
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 '
{
"uri": "sip:sbc.example.com",
"description": "Primary SBC",
"priority": 2
}
'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id}"
payload = {
"uri": "sip:sbc.example.com",
"description": "Primary SBC",
"priority": 2
}
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({uri: 'sip:sbc.example.com', description: 'Primary SBC', priority: 2})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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}
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-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.| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Label for the destination. Surfaces as description on the returned object. |
priority | integer | Yes | Routing 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 newupdated_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 itsname):
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
priorityto 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
Body
application/json
Was this page helpful?
⌘I
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 '
{
"uri": "sip:sbc.example.com",
"description": "Primary SBC",
"priority": 2
}
'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id}"
payload = {
"uri": "sip:sbc.example.com",
"description": "Primary SBC",
"priority": 2
}
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({uri: 'sip:sbc.example.com', description: 'Primary SBC', priority: 2})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/origination-uris/{uri_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}