API Reference



bool users.setPassword ( int vhost, string password, int uid = 0, string email = false, string username = false, string phone = false, string previousPassword = '', string verificationCode = NULL )


NameTypeRequiredDefault valueDescription
vhostintRequirednoneThe vhost id of the user
passwordstringRequirednoneThe users new desired password
uidintOptional0The id of the user
emailstringOptionalfalseThe email of the user
usernamestringOptionalfalseThe username of the user
phonestringOptionalfalsethe user phone number
previousPasswordstringOptional''The users previous password, required if verification code is not provided.
verificationCodestringOptionalNULLThe one time SMS or Email code the user received from regenerateCode - mandatory if previousPassword is non existant

Sample Response

Code examples


Be the first to comment on setPassword.

Add a Comment

  • captcha