You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
customerCreatePasswordResetToken
Endpoint for request a token for resetting password for the user with given e-mail address. By default, it uses the customerCreatePasswordResetTokenDefaultQuery GraphQL query
Signature
customerCreatePasswordResetToken: (
context: SetupContext,
email: string,
expose?: false,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
) => Promise<CustomerCreatePasswordResetTokenResponse | any>Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
email | Required | string | Customer email address |
expose | Optional | false | Customer email address |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Password reset token information