Skip to content
You are reading the unreleased documentation. No version is released yet, and these pages describe code that is not in a release.

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:

  • 200: no description.
  • 302: Redirect to the preference center.

One-click unsubscribe (RFC 8058)

Parameters:

  • token in query (string, required).

Responses:

  • 200: Opted out.
  • 400: Invalid token.