You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
customerResetPassword
Endpoint for resetting password for the user associated with given token. By default, it uses the customerResetPasswordDefaultQuery GraphQL query
Signature
export declare function customerResetPassword(
context: SetupContext,
tokenValue: string,
newPassword: string,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<CustomerResetPasswordResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
tokenValue | Required | string | Token for resetting user password returned from the customerCreatePasswordResetToken API endpoint |
newPassword | Required | string | New user password |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Customer data