users.setPassword

Syntax

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

Argument Info

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost id of the user
password	string	Required	none	The users new desired password
uid	int	Optional	0	The id of the user
email	string	Optional	false	The email of the user
username	string	Optional	false	The username of the user
phone	string	Optional	false	the user phone number
previousPassword	string	Optional	''	The users previous password, required if verification code is not provided.
verificationCode	string	Optional	NULL	The one time SMS or Email code the user received from regenerateCode - mandatory if previousPassword is non existant

Return Values

Field	Description	Possible Values