subscribeEmailToNewsletter
Allows guests and registered customers to sign up to receive newsletters.
Signature
declare function subscribeEmailToNewsletter(
context: Context,
input: MutationSubscribeEmailToNewsletterArgs,
customHeaders?: CustomHeaders
): Promise<FetchResult<SubscribeEmailToNewsletterMutation>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | Context | |
input | Required | MutationSubscribeEmailToNewsletterArgs | |
customHeaders | Optional | CustomHeaders |
Referenced Types
- Context
- MutationSubscribeEmailToNewsletterArgs
- CustomHeaders
FetchResultSubscribeEmailToNewsletterMutation
Examples
Simple usage:
import { sdk } from '~/sdk.config.ts';
// subscribe to newsletter
const result = await sdk.magento.subscribeEmailToNewsletter({ email: "john.doe@example.com" });