Skip to main content

UpdateUserEmailRequest

Request an update of the user's email address

Description​

  • Requests a change in the user's email address (login ID) and sends a confirmation email to the new email address.
  • If you wish to use a Sendgrid email template specific to your system, please contact Hexabase in advance. By specifying the email_templates_id issued by Hexabase, you can use your Sendgrid email template.
  • If you want to handle mail services other than Sendgrid, please refer here.

Method​

POST

Request URL Format​

/api/v0/users/email

Request URL Sample​

POST https://api.xxx.com/api/v0/users/email

Use an email service other than Sendgrid​

Payload​

{
    "email" : "[email protected]", // Email address to be changed
    "registration_path" : "/registration_page", // （(Optional) URL to which the user will be redirected after clicking the e-mail link (If omitted, the user will be redirected to the Hexabase management UI.)
    "email_templates_id" : "5fb205b03545feade82dxxxx",  // (Optional Omit this option if you wish to use the Sendgrid template for customers when sending invitation emails. Please contact Hexabase in advance and specify the email setup ID issued by Hexabase. If omitted, Hexabase's default password change screen will be used.
    "sender_address": "[email protected]" // (optional: can be omitted) Specify if you want to change the mail source to an optional value.
}

Response Sample​

{
    "error": null //Returning null signifies success. An error message is returned only if there is an error.
}

Use an email service other than Sendgrid​

The no_confirm_email flag can be specified to prevent standard outgoing mail from being sent.

Payload​

{
    "email" : "[email protected]", // Email address to be changed
    "no_confirm_email": true // If true, Hexabase standard Sendgrid mail will not be sent.
}

Response Sample​

  • no_confirm_email: If true, the confirmation_id corresponding to the request will be returned.
  • The returned confirmation_id can be used in [UpdateUserEmail] (/docs/v0/userinfo/UpdateUserEmail).
{
    "confirmation_id": "7yin62e8cjz5ngg7cbmg1wp05g8okajp3rd6r37kwg34ga37rea56vyly6nadej6qk91zgdgq868bo8rrcsiqr20pe97fuiswhsn",
    "error": null //Returning null signifies success. An error message is returned only if there is an error.
}