Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

Unsubscribe (storefront API)

Storefront and customer routes of the unsubscribe module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.

Unsubscribe via the email footer link

Parameters:

  • locale in query (string, required).
  • token in query (string, required).

Responses:

  • 302: Redirect to the preference center.

One-click unsubscribe (RFC 8058)

Parameters:

  • token in query (string, optional).

Responses:

  • 200: Opted out.
  • 400: Invalid token.
As seen on Open Source Alternatives The Merchant Engine badge