requestPasswordResetEmail
Request password reset email
Signature
declare function requestPasswordResetEmail(
context: Context,
input: MutationRequestPasswordResetEmailArgs,
customHeaders?: CustomHeaders
): Promise<FetchResult<boolean>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | Context | |
input | Required | MutationRequestPasswordResetEmailArgs | |
customHeaders | Optional | CustomHeaders |
Referenced Types
Examples
Simple usage:
import { sdk } from '~/sdk.config.ts';
// trigger sending of password reset email
const result = await sdk.magento.requestPasswordResetEmail({ email: 'john.doe@gmail.com'});
// result.data.requestPasswordResetEmail contains the boolean response from the API