reset password

1 min

POST

https://api.upstartcommerce.com/v1/customer/{customerId}/password/reset

This endpoint allows an administrator to trigger an email containing a link to the application. The link contains a JWT token on parameter paths. This token contains a temporary-generated password hash that is valid for a set time (30 minutes default). The token is used in call-customer password execute reset method.

Authorized permissions:

customer.update

customerIdstringUnique identifier for the consumer that the call should be interacting with.

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

x-upstart-sitestringUnique identifier for the site.

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.

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

curl --request POST \
     --url https://api.upstartcommerce.com/v1/customer/{customerId}/password/reset \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'