Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
const options = {
method: 'POST',
headers: {'x-spree-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'subscriber@example.com', redirect_url: '<string>'})
};
fetch('http://{defaultHost}/api/v3/store/newsletter_subscribers/request_unsubscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url http://{defaultHost}/api/v3/store/newsletter_subscribers/request_unsubscribe \
--header 'Content-Type: application/json' \
--header 'x-spree-api-key: <api-key>' \
--data '
{
"email": "subscriber@example.com",
"redirect_url": "<string>"
}
'Publishes a newsletter_subscriber.unsubscribe_requested event carrying an unsubscribe token in the payload.
Always returns 202 Accepted to prevent email enumeration.
const options = {
method: 'POST',
headers: {'x-spree-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'subscriber@example.com', redirect_url: '<string>'})
};
fetch('http://{defaultHost}/api/v3/store/newsletter_subscribers/request_unsubscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url http://{defaultHost}/api/v3/store/newsletter_subscribers/request_unsubscribe \
--header 'Content-Type: application/json' \
--header 'x-spree-api-key: <api-key>' \
--data '
{
"email": "subscriber@example.com",
"redirect_url": "<string>"
}
'Publishable API key for store access
returns accepted even when email is missing
Was this page helpful?