Skip to main content
POST
/
user
/
email
/
change
Change user email
curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/user/email/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "newEmail": "john.smith@nhost.io",
  "options": {
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}'
"OK"

Authorizations

​
Authorization
string
header
required

Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentication. For details see https://docs.nhost.io/guides/auth/elevated-permissions

Body

application/json

New email address and optional redirect URL for email change

​
newEmail
string<email>
required

A valid email

Example:

"john.smith@nhost.io"

​
options
object

Response

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

The response is of type enum<string>.

Available options:
OK
⌘I