Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Endpoint

Update an Endpoint

Update an endpoint's password, alias, or attached application.

This API allows you to update an existing endpoint's configuration. You can change the password for security purposes, update the alias for better identification, or modify the application that handles incoming calls to this endpoint.

Authentication Required:

  • • Bearer Token: Include your access token in the Authorization header
  • • X-Auth-ID Header: Your account ID (e.g., {Auth_ID})

Warning - Cannot Update:

The following fields are locked after endpoint creation and cannot be updated: username, endpoint_id, domain, allow_same_domain, allow_other_domains, allow_phones, allow_apps. To change these values, you must create a new endpoint and delete the old one.

HTTP Request

POSThttps://api.vobiz.ai/api/v1/Account/{authID}/Endpoint/{endpointID}/

Base URL:

https://api.vobiz.ai/api/v1

Request Parameters

Request Parameters

NameTypeDescription
password
stringSIP password (minimum 8 characters). Use this to reset or update the endpoint password.
alias
stringFriendly name for the endpoint.
application
integerApplication ID for call routing. This application will handle incoming calls to the endpoint.
allow_voice
booleanAllow voice calls (default: true).
allow_message
booleanAllow messaging (default: true).
allow_video
booleanAllow video calls (default: false).

Note: All parameters are optional. You only need to include the fields you want to update. Fields not provided will remain unchanged.

Response

Success Response (202 Accepted)

If successful, returns HTTP status code 202 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

Tip: After updating a password, SIP clients using this endpoint will need to re-register with the new credentials. Plan updates during maintenance windows to minimize disruption.

Retrieve an Endpoint
List all Endpoints