subscribeEmailToNewsletter mutation

The subscribeEmailToNewsletter mutation allows guests and registered customers to sign up to receive newsletters.

Syntax

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

Example usage

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

Request:

1
2
3
4
5
6
7
mutation {
  subscribeEmailToNewsletter(
    email: "email@example.com"
  ) {
    status
  }
}

Response:

1
2
3
4
5
6
7
{
  "data": {
    "subscribeEmailToNewsletter": {
      "status": "SUBSCRIBED"
    }
  }
}

Input arguments

The mutation contains a required email parameter that specifies the email address to be added into a newsletter subscription.

Output attributes

The SubscribeEmailToNewsletterOutput object contains the following attributes:

SubscriptionStatusesEnum

The SubscriptionStatusesEnum is a predefined set of possible subscription statuses:

The subscribeEmailToNewsletter mutation for the status field may return only the following statuses:

• NOT_ACTIVE
• SUBSCRIBED

Errors