Generate Reset Password Token for Customer

POST

/auth/customer/{auth_provider}/reset-password

Auth

Generate a reset password token for a customer. This API route doesn't reset the customer password or send them the reset instructions in a notification.

Instead, This API route emits the auth.password_reset event, passing it the token as a payload. You can listen to that event in a subscriber as explained in this guide, then send the customer a notification. The notification is sent using a Notification Module Provider, and it should have a URL that accepts a token query parameter, allowing the customer to reset their password from the storefront.

Use the generated token to update the customer's password using the Reset Password API route.

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request POST '{{BASE_URL}}/auth/customer//reset-password' \
--header 'Content-Type: application/json' \
--data-raw '"customer@gmail.com"'

Response Example

400 - Not Allowed Error

{
    "message": "Discount must be set to dynamic",
    "type": "not_allowed"
}

Request

Path Params

auth_provider

string

required

The provider used for authentication.

Example:

emailpass

Body Params application/json

object {0}

Examples

Responses

🟢201Created

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Authenticate Customer

Refresh Authentication Token