Request a password reset - Spree Commerce documentation

POST

api

store

password_resets

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

await client.passwordResets.create({
  email: 'customer@example.com',
  redirect_url: 'https://myshop.com/reset-password',
})

{
  "message": "If an account exists for that email, password reset instructions have been sent."
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Body

application/json

string<email>

required

Email address of the account to reset

Example:

"customer@example.com"

redirect_url

string<uri>

URL to redirect the user to after clicking the reset link. Validated against the store's allowed origins.

Example:

"https://myshop.com/reset-password"

Response

email not found (same response to prevent enumeration)

message

string

Logout

Reset password with token

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

await client.passwordResets.create({
  email: 'customer@example.com',
  redirect_url: 'https://myshop.com/reset-password',
})

{
  "message": "If an account exists for that email, password reset instructions have been sent."
}