Subscribe to Newsletter
Subscribe the authenticated customer to the store newsletter for the current channel.
Endpoint
POST /api/shop/newslettersRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Authorization | Yes | Customer Bearer token (Bearer <accessToken>) |
Request Body
json
{
"customerEmail": "[email protected]"
}| Field | Type | Required | Description |
|---|---|---|---|
customerEmail | string | Yes | Email address to subscribe. Must be a valid email and unique in the subscribers list. |
Response Fields (200 OK)
| Field | Type | Description |
|---|---|---|
success | boolean | true when the subscription was created successfully. |
message | string | Human-readable confirmation or error message. |
Validation
customerEmailis required and must be a valid email format.- The email must not already exist in the subscribers list for the channel.
- A valid customer Bearer token is required.
Use Cases
- Newsletter opt-in from the storefront footer or account page
- Re-subscribe a customer who previously unsubscribed
- Capture marketing consent at checkout or registration
Notes
- The subscription is scoped to the current channel (resolved from the storefront key).
- Field names are camelCase (
customerEmail).