メインコンテンツまでスキップ

UpdateUserEmailRequest

ユーザーメールアドレスの更新をリクエストする

Description​

  • ユーザーのメールアドレス（ログインID）の変更をリクエストし、変更先のメールアドレスに確認メールを送信します。
  • システムに固有のSendgridメールテンプレートを利用する場合は、事前にHexabase社へ必要事項を連絡します。Hexabase社より発行されたemail_templates_idを指定することで、独自のSendgridメールテンプレートを利用できます。
  • Sendgrid以外のメールサービスを扱いたい場合は、こちら をご確認ください。

Method​

POST

Request URL Format​

/api/v0/users/email

Request URL Sample​

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

Sendgrid以外のメールサービスを利用する​

Payload​

{
    "email" : "[email protected]", // 変更先のメールアドレス
    "registration_path" : "/registration_page", // （省略可能）メールリンクをクリック後に遷移するURL（省略するとHexabase管理UIへ遷移する）
    "email_templates_id" : "5fb205b03545feade82dxxxx",  // （任意 省略可能）招待メールを送信する際にお客様用のSendgridテンプレートを使用する場合に設定します。事前にHexabase社へ必要事項を連絡し、Hexabase社より発行されたemail設定IDを指定します。 省略するとHexabaseのデフォルトのパスワード変更画面が利用されます。
    "sender_address": "[email protected]", // (任意 省略可能) メールのfromアドレスを任意の値に変更したい場合に指定します
    "sender_name": "Hexabase" // (任意 省略可能) メールのfrom名前を任意の値に変更したい場合に指定します
}

Response Sample​

{
    "error": null //成功の場合 nullが返る。エラーがあった場合のみエラーメッセージが返却される。
}

Sendgrid以外のメールサービスを利用する​

no_confirm_emailフラグを指定することで、標準の送信メールを送信しないよう設定できます。

Payload​

{
    "email" : "[email protected]", // 変更先のメールアドレス
    "no_confirm_email": true // true指定でHexabase標準のSendgridメールが送信されなくなります
}

Response Sample​

  • no_confirm_email: trueとした場合、リクエストに対応したconfirmation_idが返却されます
  • 返却されたconfirmation_idをUpdateUserEmail で使用できます
{
    "confirmation_id": "7yin62e8cjz5ngg7cbmg1wp05g8okajp3rd6r37kwg34ga37rea56vyly6nadej6qk91zgdgq868bo8rrcsiqr20pe97fuiswhsn",
    "error": null //成功の場合 nullが返る。エラーがあった場合のみエラーメッセージが返却される。
}