Credentials
Update Credential
Rotate the password, toggle the enabled state, or update the description of a Vobiz SIP credential without interrupting other active trunk authentications.
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>"
}
'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}"
payload = { "password": "<string>" }
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({password: '<string>'})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_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",
"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}
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-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.| Field | Type | Required | Description |
|---|---|---|---|
password | string | No | New SIP password. Minimum 8 characters. Recommended: 12+ characters with mixed case, numbers, and special characters. |
enabled | boolean | No | Whether the credential is active. Set to false to temporarily disable authentication without deleting the credential. Set to true to re-enable. |
description | string | No | Updated 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. Theupdated_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
enabledflag 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
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Body
application/json
Was this page helpful?
⌘I
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>"
}
'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_id}"
payload = { "password": "<string>" }
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({password: '<string>'})
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/credentials/{credential_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",
"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"
}