Start updating the current email address

Request

Updates the user's email address. The user will receive an email with a one-time password (OTP) to verify the new email address. In order to finish the process, the user must provide the OTP to the /zephr/users/update-email/{otp} endpoint. The difference between this endpoint and the /blaize/users/update-email endpoint is that this endpoint requires the extra layer of authentication through the required validator.

Security

CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie

Bodyapplication/json

current_identifiersobject(identifiers)required

Example:

{
  "email_address": "john.doe@company.com"
}

new_identifiersobject(identifiers)required

Example:

{
  "email_address": "doe.john@company.com"
}

validatorsobject(validators)required

Example:

{
  "password": "mysecurepassword123"
}

{
  "current_identifiers": {
    "email_address": "john.doe@company.com"
  },
  "new_identifiers": {
    "email_address": "doe.john@company.com"
  },
  "validators": {
    "password": "mysecurepassword123"
  }
}

Responses

OK. The confirmation email was sent successfully.

Headers

any

Bodyapplication/json

messagestring

Example:"Email with OTP sent to verify new email address"

Response

{
  "message": "Email with OTP sent to verify new email address"
}