UnsubscribeCustomer

Description

Unsubscribes an e-mail address from newsletter subscriptions. Operation name: unsubscribeCustomer.

The subscriber record is retained and marked as unsubscribed for history/audit purposes.

Endpoint

mutation unsubscribeCustomer($email: String!) {
  unsubscribeCustomer(email: $email) {
    success
    message
    subscribedEmail
    alreadyExists
    wasReactivated
  }
}

Arguments

Argument	Type	Required	Description
email	String	Yes	Subscriber e-mail address.

Return Values

Returns CustomerSubscription:

Field	Type	Description
success	Boolean	Whether operation completed successfully.
message	String	Human-readable result message.
subscribedEmail	String	E-mail that was processed.
alreadyExists	Boolean	Whether subscriber record exists.
wasReactivated	Boolean	Always not applicable for unsubscribe flow.

Usage Example

mutation {
  unsubscribeCustomer(email: "customer@example.com") {
    success
    message
    alreadyExists
  }
}

Notes

• Plugin setting customerSubscriptionEnabled must be enabled.
• Runtime code tracks wasUnsubscribed, but this key is not exposed in GraphQL type; use success + message in clients.