Start an email address update

Request

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.

Security

ZephrHmacHttp

Path

user_idstringrequired

Unique User identifier

Bodyapplication/json

new_identifiersobjectrequired

Example:

{
  "email_address": "joe.blow@company.com"
}

{
  "new_identifiers": {
    "email_address": "joe.blow@company.com"
  }
}

Responses

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.

Headers

any