Endpoints
Update an Endpoint
Modify a Vobiz SIP endpoint - rotate its password, update the alias, swap the attached application, or toggle voice and video permissions; no re-provisioning.
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Endpoint
/
{endpoint_id}
/
Update an Endpoint
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/ \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data @- <<EOF
{
"alias": "John's Updated Desktop Phone",
"password": "NewSecurePassword456!"
}
EOFimport requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/"
payload = {
"alias": "John's Updated Desktop Phone",
"password": "NewSecurePassword456!"
}
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({alias: 'John\'s Updated Desktop Phone', password: 'NewSecurePassword456!'})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"<string>{
"api_id": "<string>",
"error": "<string>",
"message": "<string>"
}POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/
Authentication required:
X-Auth-ID- Your account Auth ID (e.g.,{auth_id})X-Auth-Token- Your account Auth TokenContent-Type: application/json
Cannot Update: The following fields are locked after endpoint creation:
username, endpoint_id, domain, allow_same_domain, allow_other_domains, allow_phones, allow_apps. To change these values, create a new endpoint and delete the old one.Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
password | string | No | SIP password (minimum 8 characters). Use this to reset or update the endpoint password. |
alias | string | No | Friendly name for the endpoint. |
application | integer | No | Application ID for call routing. This application will handle incoming calls to the endpoint. |
allow_voice | boolean | No | Allow voice calls (default: true). |
allow_message | boolean | No | Allow messaging (default: true). |
allow_video | boolean | No | Allow video calls (default: false). |
All parameters are optional. You only need to include the fields you want to update. Fields not provided will remain unchanged.
Setting
application to a different numeric app_id swaps which application handles this endpoint’s calls. An unknown app_id returns a 400. An endpoint binds to exactly one application at a time.Response
Success Response (202 Accepted)
On success, returns HTTP status code202 Accepted with no response body.
Response - 202 Accepted
HTTP/1.1 202 Accepted
Error Response (400 Bad Request)
Response - 400 Bad Request
{
"error": "invalid request parameters",
"details": {
"password": "Password must be at least 8 characters"
}
}
Error Response (404 Not Found)
Response - 404 Not Found
HTTP/1.1 404 Not Found
Examples
Update Alias
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/87654321/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"alias": "John'\''s Updated Desktop Phone"
}'
Update Password
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/87654321/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"password": "NewSecurePassword456!"
}'
Update Multiple Fields
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/87654321/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"alias": "John'\''s Updated Desktop Phone",
"password": "NewSecurePassword456!",
"application": 98765432,
"allow_voice": true,
"allow_message": true,
"allow_video": true
}'
Common Use Cases:
- Reset forgotten endpoint passwords
- Update aliases to reflect role changes
- Switch applications for different call routing logic
- Rotate passwords regularly for security
- Enable or disable video/messaging capabilities
After updating a password, SIP clients using this endpoint must re-register with the new credentials. Plan updates during maintenance windows to minimize disruption.
Authorizations
Path Parameters
Body
application/json
Response
Success
The response is of type string.
Was this page helpful?
⌘I
Update an Endpoint
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/ \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data @- <<EOF
{
"alias": "John's Updated Desktop Phone",
"password": "NewSecurePassword456!"
}
EOFimport requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/"
payload = {
"alias": "John's Updated Desktop Phone",
"password": "NewSecurePassword456!"
}
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({alias: 'John\'s Updated Desktop Phone', password: 'NewSecurePassword456!'})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"<string>{
"api_id": "<string>",
"error": "<string>",
"message": "<string>"
}