Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Credentials

Update Credential

Modify existing SIP credential properties.

This API updates an existing credential's password, enabled status, or description. Use this endpoint to rotate passwords, enable or disable credentials, or update descriptive information.

Important Limitation: The username cannot be changed after credential creation. If you need a different username, you must 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 will not be returned in the response.

HTTP Request

PUThttps://api.vobiz.ai/api/v1/account/{account_id}/credentials/{credential_id}

Authentication: Bearer token required. Include X-Auth-ID header.

Request Parameters

All parameters are optional. Include only the fields you want to update.

Request Parameters

NameTypeDescription
password
stringNew SIP password. Minimum 8 characters. Use this to rotate passwords regularly for security. Recommended: 12+ characters with mixed case, numbers, and special characters.
enabled
booleanWhether the credential is active. Set to false to temporarily disable authentication without deleting the credential. Set to true to re-enable.
description
stringUpdated description for the credential. Use this to document changes like "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 with the new values. The password is not included in the response. Note the updated_at timestamp reflects when the change was made.

Response - 200 OK
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",

  "username": "trunk_user_001",
  "enabled": false,
  "description": "Updated credential description",
  "created_at": "2025-01-15T10:35:20Z",
  "updated_at": "2025-01-22T11:15:45Z"
}

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 doesn't exist or doesn't belong to the specified trunk, you'll receive a 404 Not Found error.

Retrieve All Credentials
Delete Credential