Skip to main content
POST
Request an unsubscribe token

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required

Body

application/json
email
string<email>
Example:

"subscriber@example.com"

redirect_url
string<uri>

Storefront URL the unsubscribe token should be appended to in the resulting email. Silently dropped from the event payload if outside the store's allowed origins.

Response

202

returns accepted even when email is missing