Skip to main content
PUT
/
api
/
v1
/
Account
/
{auth_id}
/
credentials
/
{credential_id}
Update a credential
curl --request PUT \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "password": "<string>"
}
'
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "username": "acme_sip_user_01",
  "password": "<redacted>",
  "realm": "MA_XXXXXXXX.sip.vobiz.ai",
  "enabled": true,
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T11:30:00Z"
}
PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}
Updates an existing credential’s password, enabled status, or description. Use this endpoint to rotate passwords, enable or disable credentials, or update descriptive information.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Important Limitation: The username cannot be changed after credential creation. To use a different username, create a new credential and delete the old one.Security Note: When updating the password, ensure it meets minimum security requirements (8+ characters). The new password is not returned in the response.

​
Request Parameters

All parameters are optional. Include only the fields you want to update.
FieldTypeRequiredDescription
passwordstringNoNew SIP password. Minimum 8 characters. Recommended: 12+ characters with mixed case, numbers, and special characters.
enabledbooleanNoWhether the credential is active. Set to false to temporarily disable authentication without deleting the credential. Set to true to re-enable.
descriptionstringNoUpdated description for the credential (e.g., “Rotated password on 2025-01-22” or “Assigned to new device”).
Note: The username field cannot be updated. It is immutable after credential creation.

​
Response

Returns the updated credential object. The password is not included in the response. The updated_at timestamp reflects when the change was made.
Response - 200 OK
{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "username": "sipuser_demo",
  "password": "<redacted>",
  "realm": "MA_XXXXXXXX.sip.vobiz.ai",
  "enabled": true,
  "created_at": "2026-05-12T05:11:51.635107Z",
  "updated_at": "2026-05-12T05:11:51.683393Z"
}

​
Examples

​
cURL - Update Password

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "UpdatedSecurePassword456!",
    "description": "Password rotated on 2025-01-22"
  }'

​
cURL - Disable Credential

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false,
    "description": "Temporarily disabled for maintenance"
  }'

​
cURL - Re-enable Credential

cURL Request
curl -X PUT https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "description": "Re-enabled after maintenance"
  }'
Best Practices:
  • Rotate passwords quarterly or when a device is compromised
  • Use the enabled flag to disable credentials temporarily instead of deleting them
  • Update the description when making changes to document the reason
  • Notify affected users before changing passwords to prevent service disruption
Error Response (404): If the credential_id does not exist or does not belong to the specified trunk, the API returns a 404 Not Found error.

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"

​
credential_id
string
required

Body

application/json
​
password
string
required

Response

200 - application/json

Credential updated

​
id
string
required
​
account_id
string
required
​
username
string
required
​
password
string
required
​
realm
string
required
​
enabled
boolean
required
​
created_at
string
required
​
updated_at
string
required