updateUserEmail()

Updates the user’s email address.

This function updates the user’s email address and, if provided, verifies it using a verification token (typically from an OTP flow).
If a userId is provided, it updates the email for that specific user; otherwise, it uses the current session’s userId.
If a verificationToken is not provided, the email will be updated but will not be marked as verified.
Automatically ensures an active session exists before making the request.
Handles session management and error reporting for both update and verification flows.

Package: core

Defined in: core.ts:2693

params

object

required

Show params details

params.email

string

required

new email address to set for the user.

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.userId

string

user ID to update a specific user’s email (defaults to the current session’s userId).

params.verificationToken

string

verification token from OTP email verification (required if verifying the email).

A successful response returns the following fields:

returns

string

required

A promise that resolves to the userId of the updated user.