Start an email address update

Starts an email address update. If the Require Email Verification configuration flag is set, to update a user's email address, first they need to verify their new address. If the Email Change Override feature flag is enabled, the an email with a link to verify the address will be sent to the new address. Otherwise the email will be sent to the old address. If the Require Email Verification configuration flag is not set, this endpoint sets the new email address immediately. If the user has a username and the provided email address is blank, the email address is deleted. If the user does not have a username and the provided email address is blank, a 400 is returned.

SecurityZephrHmacHttp
Request
path Parameters
user_id
required
string

Unique User identifier

Request Body schema: application/json
required
object
Responses
201

OK. The process to update email started and is potentially already completed, depending on the Email Verification configuration flag. See endpoint description for more information.

400

Bad Request

404

User ID not Found

409

Email address already in use

post/v3/users/{user_id}/update-email
Request samples
application/json
{
  • "new_identifiers": {
    }
}