1. References
  2. VoxEngine
  3. VoximplantAPI
  4. SetUserInfoRequest
Rate this page:

SetUserInfoRequest

Props

applicationId

Copy URL
applicationId: 
number
 | 
undefined

The application ID. It is required if the user_name is specified

applicationName

Copy URL
applicationName: 
string
 | 
undefined

The application name that can be used instead of application_id

mobilePhone

Copy URL
mobilePhone: 
string
 | 
undefined

newUserName

Copy URL
newUserName: 
string
 | 
undefined

The new user name in format [a-z0-9][a-z0-9_-]{2,49}

parentAccounting

Copy URL
parentAccounting: 
false
 | 
undefined
 | 
true

Whether to use the parent account's money, 'false' to use a separate user balance

userActive

Copy URL
userActive: 
false
 | 
undefined
 | 
true

Whether the user is active. Inactive users cannot log in to applications

userCustomData

Copy URL
userCustomData: 
string
 | 
undefined

Any string

userDisplayName

Copy URL
userDisplayName: 
string
 | 
undefined

The new user display name. The length must be less than 256

userId

Copy URL
userId: 
number

The user to edit

userName

Copy URL
userName: 
string

The user name that can be used instead of user_id

userPassword

Copy URL
userPassword: 
string
 | 
undefined

The new user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character