Skip to content

fix(shared): Add additional fields to signUp.update #8320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dstaley merged 1 commit into from
Apr 15, 2026
Merged

fix(shared): Add additional fields to signUp.update #8320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/green-sides-tickle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Add `emailAddress`, `phoneNumber`, and `username` support to `signUp.update()`
22 changes: 19 additions & 3 deletions packages/shared/src/types/signUpFuture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,25 @@ export interface SignUpFutureCreateParams extends SignUpFutureAdditionalParams {
web3Wallet?: string;
}

// This will likely get more properties
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
export interface SignUpFutureUpdateParams extends SignUpFutureAdditionalParams {}
export interface SignUpFutureUpdateParams extends SignUpFutureAdditionalParams {
/**
* The user's email address. Only supported if [Email address](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#email)
* is enabled. Keep in mind that the email address requires an extra verification process.
*/
emailAddress?: string;
/**
* The user's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). Only supported if
* [phone number](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled.
* Keep in mind that the phone number requires an extra verification process.
*/
phoneNumber?: string;
/**
* The user's username. Only supported if
* [username](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#username) is enabled in
* the instance settings.
*/
username?: string;
}

export interface SignUpFutureEmailCodeVerifyParams {
/**
Expand Down
Loading