Skip to main content

Change Email

PUT 
/api/users/me/email

Change the email of the currently authenticated user.

If email is enabled, the user needs to verify this email address with a token that is sent to the new email address. Only then the email is changed in the database. If email is disabled, the email will be changed immediately.

Requirements​

  • The email should be a valid email address (e.g., "[email protected]") that is not associated to an existing account.

You can find more information about profile management here.

Locale​

A locale can be specified for this request. The email will be sent in the specified locale. You can learn more about locale in emails here.

If no locale is specified, the applications default locale will be used. You can learn more about configuring the default locale here.

Tokens​

  • A valid AccessToken is required.
  • A valid StepUpToken is required. This token should match user and session contained in the AccessToken.

Request​

Responses​

If email is enabled, verificationRequired will be true indicating that this request did not update the user, otherwise verificationRequired is false. Since this request sends an email, the remaining cooldown in seconds will be returned.