requestPasswordReset

client.requestPasswordReset(
  email,
  phoneNumber
  success,
  failure
  // Optional arguments
  redirectUrl,
)

About this command

Request a password reset for a profile. It will send an email if the email address is provided and an SMS if the phone number is given.

Be sure to configure and to enable the Password reset email or the Password reset SMS templates in the account’s settings.

Examples

  • With an email

  • With a phone number

client.requestPasswordReset(
    email = "john.doe@gmail.com",
    redirectUrl = "https://example-password-reset.com"
    success = { _ -> ... }, // Do something
    failure = { error -> ... } // Handle a ReachFive error
)
client.requestPasswordReset(
    phoneNumber = "+33682234940",
    success = { _ -> ... }, // Do something
    failure = { error -> ... } // Handle a ReachFive error
)

Parameters

email string

The email address of the profile.

phoneNumber string

The phone number of the profile.

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

redirectUrl string

The URL sent in the email to which the user is redirected. This URL must be whitelisted in the Allowed Callback URLs field of your ReachFive client settings.

success function

Callback called once the request has succeeded. No argument is expected.

failure function

Callback called once the request has failed. You’ll get a ReachFiveError as an argument.

Response

Type: Unit

ReachFiveError

message string

The message of the error.

getErrorCode() ErrorCode

The error code’s enumeration value.

code string

The HTTP status code or SDK error code.

exception string

The stack trace of the error.

data ReachFiveApiError

Additional data about the error.

error string

The main error message.

errorId string

The identifier of the error.

errorUserMsg string

The user-friendly error message.

This property is translated according to the user’s browser settings. Currently supported languages:
Currently supported languages
  • de - Deutsch German

  • en - English

  • es - Español Spanish

  • fr - Français French

  • hu - Magyar Hungarian

  • it - Italiano Italian

  • nl - Nederlands Dutch

  • ru - Ру́сский Russian

  • sk - Slovenský Slovak

  • pt - Portuguese

errorMessageKey string

The technical error code.

errorDescription string

The technical error message.

errorDetails ReachFiveApiErrorDetails

  • field - The field concerned by the error.

  • message - The message error returned for the field.