Home > @vue-storefront/magento-api > requestPasswordResetEmail

requestPasswordResetEmail() function

Requests a password reset email to be sent to the user

Signature:

export default function requestPasswordResetEmail(context: Context, input: RequestPasswordResetEmailMutationVariables, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<FetchResult<RequestPasswordResetEmailMutation>>;

Parameters

Parameter	Type	Description
context	Context	VSF Context
input	RequestPasswordResetEmailMutationVariables	Email for which to request a password reset
customQuery	CustomQuery	(Optional) (optional) - custom GraphQL query that extends the default one
customHeaders	CustomHeaders	(Optional) (optional) - custom headers that extends the default headers

Returns:

Promise<FetchResult<RequestPasswordResetEmailMutation>>