Anchor to section titled 'undefined'

customerEmailMarketingSubscribe
mutation

Requires unauthenticated_write_customers access scope.

Subscribes a customer to the newsletter with an email address.

Anchor to section titled 'Arguments'

Arguments

Anchor to email
email
String!
required

The customer's email address.

Was this section helpful?
Anchor to section titled 'CustomerEmailMarketingSubscribePayload returns'

CustomerEmailMarketingSubscribePayload returns

Anchor to CustomerEmailMarketingSubscribePayload.customer
customer
CustomerMarketingSubscribe

The created customer object.

Anchor to CustomerEmailMarketingSubscribePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerEmailMarketingSubscribe($email: String!) {
  customerEmailMarketingSubscribe(email: $email) {
    customer {
      # CustomerMarketingSubscribe fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
  }
}
Hide code
Input
Copy
{
  "email": "<your-email>"
}