Skip to main content
POST
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required

Body

application/json
email
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