updateEmail

client.updateEmail({
  accessToken: string,
  email: string,
  captchaToken: string,
  // Optional fields
  redirectUrl: string,
})

About this command

Update the profile’s email address and send a verification email.

The profile must have been granted the full_write scope at the last authentication.
It is required to configure and enable the Email update template in the account’s settings.

Examples

client.updateEmail({
  accessToken: 'eyJ0eXAiOiJKV1QiL...',
  email: 'johnatthan.doe@gmail.com',
  captchaToken: 'pyJ0e9WiOimld1Qiqm',
  redirectUrl: 'https://example-email-update.com'
})

Parameters

Parameter Description

captchaToken string

Pass along the response token you have received from reCAPTCHA. See Google’s documentation on how to obtain it.

Defaults to null.

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old.

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.

email string

The email address of the profile. The new email address must be different from the old one.

Unverified emails: If the email being updated is unverified, the user’s email is updated immediately.
Verified emails: If the email being updated is verified, the user must click on the verification link sent in the email to finish the update email flow. Users won’t be able to use the new email for authentication until it is verified.

For more, see our Email address management page.

Response

Type: Promise[void]