Newsletter (storefront API)
Storefront and customer routes of the newsletter module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.
GET /v1/newsletter/confirm
Section titled “GET /v1/newsletter/confirm”Confirm a newsletter subscription
Parameters:
localein query (string, required).tokenin query (string, required).
Responses:
200: no description.302: Redirect to the storefront confirmation page.
POST /v1/newsletter/subscribe
Section titled “POST /v1/newsletter/subscribe”Subscribe to the newsletter (double opt-in)
Request body: SubscribeDto.
Responses:
202: Confirmation email sent if applicable.400: Invalid email.
GET /v1/newsletter/unsubscribe
Section titled “GET /v1/newsletter/unsubscribe”Unsubscribe via the email footer link
Parameters:
localein query (string, required).tokenin query (string, required).
Responses:
200: no description.302: Redirect to the storefront confirmation page.
POST /v1/newsletter/unsubscribe
Section titled “POST /v1/newsletter/unsubscribe”One-click newsletter unsubscribe (RFC 8058)
Parameters:
tokenin query (string, required).
Responses:
200: Opted out.
Schemas
Section titled “Schemas”SubscribeDto
Section titled “SubscribeDto”email(string, max length 254, required).locale("fr","en","ar", optional).