ResetPassword

Starts the password reset process for a client or contact.

Request Parameters

Parameter Type Description Required
action string “ResetPassword” Required
id int The id of the client to reset. The id can only belong to a client. Optional
email string The email address of the client or contact to update. Either $id or $email is required Optional
answer string The answer to the client security question if appropriate Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'ResetPassword',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'email' => '[email protected]',
            'answer' => 'alphabet',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

$command = 'ResetPassword';
$postData = array(
    'email' => '[email protected]',
    'answer' => 'alphabet',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response JSON

{
    "result": "success"
}

Error Responses

Possible error condition responses include:

  • Client ID Not Found
  • Please enter the email address or provide the id
  • No account was found with the email address you entered
  • The security question answer entered does not match the answer set in the account
  • The security question answer must be provided for this account

Version History

Version Changelog
1.0 Initial Version