MageSmith
MutationNewsletter · Magento 2.4.9

subscribeEmailToNewsletter

subscribeEmailToNewsletter is a Magento 2 GraphQL mutation in the Newsletter module. Subscribe the specified email to the store's newsletter. It returns SubscribeEmailToNewsletterOutput and requires an Authorization header (Bearer customer token).

Last verified: against Magento 2.4.9.

Returns

SubscribeEmailToNewsletterOutput

Resolver class

Magento\NewsletterGraphQl\Model\Resolver\SubscribeEmailToNewsletter

Arguments

email String! Required

The email address that will receive the store's newsletter.

Example request

Auto-generated from the SDL — paste-ready against your store's /graphql endpoint. Replace the host, store code, and any required values before running.

Headers

Content-Type
application/json
Store
default store view code; use 'default' for the single-store baseline
Authorization
Bearer <CUSTOMER_TOKEN> obtain from generateCustomerToken mutation

Query

mutation ($email: String!) {
  subscribeEmailToNewsletter(email: $email) {
    status
  }
}

Variables

{
  "email": ""
}

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →