reset password

1 min

PUT

https://api.upstartcommerce.com/v1/customer/password/reset

This endpoint sends an email containing a link to the tenant's site. The link contains a JWT token on the parameter path. The Token contains a temporary generated password hash that is valid for set time (30 minutes default). The token is used in the call consumer password execute reset method.

Authorized roles:

customer.anonymous

x-upstart-tenantstringTenant identifier associated with the site this call is for.

x-upstart-sitestringUnique identifier for the site.

bodyobject

200<p>Success-email sent.</p>

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403<p>An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.</p>

404The requested resource was not found in the NoChannel system.

curl --request PUT \
     --url https://api.upstartcommerce.com/v1/customer/password/reset \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "login": "bob.smith.29"
     }'