Home > @vue-storefront/magento-api > subscribeEmailToNewsletter
subscribeEmailToNewsletter() function
Subscribes an email in the newsletter.
Signature:
export default function subscribeEmailToNewsletter(context: Context, { email }: SubscribeEmailToNewsletterMutationVariables, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<FetchResult<SubscribeEmailToNewsletterMutation>>;
Parameters
Parameter | Type | Description |
---|---|---|
context | Context | VSF context |
{ email } | SubscribeEmailToNewsletterMutationVariables | |
customQuery | CustomQuery | (Optional) (optional) - custom GraphQL query that extends the default query |
customHeaders | CustomHeaders | (Optional) (optional) - custom headers that extends the default headers |
Returns:
Promise<FetchResult<SubscribeEmailToNewsletterMutation>>