Skip to content

Recover a customer password ​

Endpoint: https://my-store.youcan.shop/api/customers/recover

Method: POST

Sends a password reset email. The store sends it only when an account exists for the email. The response is the same in both cases.

The email links to the store's reset page, /account/reset/{id}/{token}. Send the id and token of that link to the Reset endpoint.

Parameters ​

Param NameParam TypeDescriptionRequired
emailstringCustomer emailyes

Response ​

[200] OK

json
{
    "message": "If an account exists, a reset email was sent"
}