Skip to content

Change user email

POST
/user/email/change

Request to change the authenticated user’s email address. A verification email will be sent to the new address to confirm the change. Requires elevated permissions.

New email address and optional redirect URL for email change

object
newEmail
required

A valid email

string format: email
Example
john.smith@nhost.io
options
object
redirectTo
string format: uri
Example
https://my-app.com/catch-redirection

Email change requested. An email with a verification link has been sent to the new address

string
Allowed values: OK

An error occurred while processing the request

Standardized error response

object
status
required

HTTP status error code

integer
Example
400
message
required

Human-friendly error message

string
Example
Invalid email format
error
required

Error code identifying the specific application error

string
Allowed values: default-role-must-be-in-allowed-roles disabled-endpoint disabled-user email-already-in-use email-already-verified forbidden-anonymous internal-server-error invalid-email-password invalid-request locale-not-allowed password-too-short password-in-hibp-database redirectTo-not-allowed role-not-allowed signup-disabled unverified-user user-not-anonymous invalid-pat invalid-refresh-token invalid-ticket disabled-mfa-totp no-totp-secret invalid-totp mfa-type-not-found totp-already-active invalid-state oauth-token-echange-failed oauth-profile-fetch-failed oauth-provider-error invalid-otp cannot-send-sms provider-account-already-linked