Skip to content
docs
Guides
ES
CustomersCustomer

Request password recovery

Sends the customer a link to set a new password. Responds 200 whether or not the address belongs to an account, so the endpoint cannot be used to discover which emails are registered.

POST/v1/customer/recovery-password

Sends the customer a link to set a new password. Responds 200 whether or not the address belongs to an account, so the endpoint cannot be used to discover which emails are registered.

Header Parameters

x-Store-Domain*string

Store slug or configured domain that selects the store context at the central Storefront gateway.

Length1 <= length <= 253

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/customer/recovery-password" \  -H "x-Store-Domain: my-store" \  -H "Content-Type: application/json" \  -d '{    "email": "andrea@example.com"  }'
{  "accepted": false}