BAbagisto
Customer

Reset password

Changed on

Sets a new password with the token from the forgot-password email. The token is the last segment of the reset link (/customer/reset-password/{token}). A token can be used once and expires after the time set in the auth config. No customer login is needed. The emailed link opens the storefront reset page; an app that wants its own screen should open that link as a deep link and call this endpoint.

post/reset-passwords

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

tokenstring required
emailstring required
passwordstring required
passwordConfirmationstring required

Example request

{
  "token": "5f2b9c…",
  "email": "john@example.com",
  "password": "NewSecret123",
  "passwordConfirmation": "NewSecret123"
}

Response

Password changed.

Changes