requestPasswordReset

Deprecation Notice

This SDK is deprecated in favor of the Core and UI JS SDKs. See Migrating to the latest SDKs to use the latest Core and UI SDKs.

Support for the Legacy JS SDK ends on 28 February, 2021.

 
reach5('requestPasswordReset', {
  email: string,
  phoneNumber: string,
})

About this command

Requests a password reset for the given email or phoneNumber. On success, an email or a SMS with a reset token is sent to the user.

Examples

reach5('requestPasswordReset', {
  email: 'john.doe@example.com'
}, function (err) {
  if (err) {
    // Handle error
    return;
  }
  // Handle success
});

Parameters

email string

User’s email

redirectUrl string

The URL the user will be redirected to after clicking on the link contained in the email. This URL must be whitelisted in the Allowed Callback URLs field of your ReachFive client settings.

phoneNumber string

User’s phone number.

Both the international format and the national conventions of the account’s country are accepted if configured in account settings.