Start a customer password reset flow

Public storefront endpoint. When called from a browser origin that is registered in the store's Storefront API allowed origins, the reset email link uses that origin as http(s)://<allowed-storefront-host>/reset-password?token=<reset-token>. Calls without an Origin header fall back to the hosted storefront custom domain and use the same /reset-password?token=... path.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Store unique_id.

Body Params

Starts a customer password reset. Storefront API reset email links use http(s)://<allowed-storefront-host>/reset-password?token=<reset-token>. Browser calls should rely on the registered Origin header for reset-link hostname selection; the API falls back to the hosted storefront custom domain when Origin is not present.

string
required
Headers
string
required

Publishable storefront public API key for the target store. Page public API keys are not accepted on Storefront public routes.

Responses
204

Success with no response body

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json