sendEmailVerification

client.sendEmailVerification({
  accessToken: string,
  // Optional parameters
  redirectUrl: string,
  returnToAfterEmailConfirmation: string
})

About this command

Request the verification of the email address of a profile. If there is an email address configured in the profile that was not already verified, sends an email to verify it.

Examples

client.sendEmailVerification({
  accessToken: 'eyJ0eXAiOiJKV1QiL...',
  redirectUrl: 'https://example-email-verification.com'
})

Parameters

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API.

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.

returnToAfterEmailConfirmation string

Returned in the redirectUrl as a query parameter, this parameter is used as the post-email confirmation URL.

Response

Type: Promise[void]

Feedback