subscribeEmailToNewsletter mutation

The subscribeEmailToNewsletter mutation allows guests and registered customers to sign up to receive newsletters. It can return a value of NOT_ACTIVE or SUBSCRIBED.

Syntax

mutation: {subscribeEmailToNewsletter(email: String!): SubscribeEmailToNewsletterOutput}

Reference

The subscribeEmailToNewsletter reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following call subscribes an email to the store's newsletter.

Request:

Copy
mutation {
  subscribeEmailToNewsletter(
    email: "email@example.com"
  ) {
    status
  }
}
Copied to your clipboard
mutation {
  subscribeEmailToNewsletter(
    email: "email@example.com"
  ) {
    status
  }
}

Response:

Copy
{
  "data": {
    "subscribeEmailToNewsletter": {
      "status": "SUBSCRIBED"
    }
  }
}
Copied to your clipboard
{
  "data": {
    "subscribeEmailToNewsletter": {
      "status": "SUBSCRIBED"
    }
  }
}

Errors

Last updated 11/25/2023

Was this helpful?

Yes

No