handleUpdateUserName()

Package: react-wallet-kit

Defined in: react-wallet-kit/src/providers/client/Types.tsx:490

Handles the update user email flow.

This function opens a modal with the UpdateEmail component for updating and verifying the user’s email address.
If an email is provided, it will immediately send an OTP request to the user and display the OTP verification modal.
Supports both manual entry and pre-filled email addresses, as well as custom modal titles and subtitles.
Uses the updateEmailContinue helper to manage the OTP flow, verification, and update logic.
After successful verification and update, the user details state is refreshed and an optional success page can be shown.
Supports customizing the duration of the success page after update.
Handles all error cases and throws a TurnkeyError with appropriate error codes.

params

object

Show params details

params.stampWith

StamperType

parameter to specify the stamper to use for the update (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.subTitle

string

subtitle for the modal.

params.successPageDuration

number

duration (in ms) for the success page after update (default: 0, no success page).

params.title

string

title for the modal.

params.userName

string

A successful response returns the following fields:

returns

string

required

A promise that resolves to the userId of the user that was changed.