Unsubscribe from the newsletter

Destroys the newsletter subscription, firing the newsletter_subscriber.deleted lifecycle event. Two authorization paths are accepted:

Unsubscribe token in the ?token= query param — bearer delivered to the subscriber by email (the link in an unsubscribe message). The token is cryptographically signed and is cross-checked against the :id in the URL — tampering with either is rejected. To request such an email be sent, call the collection action POST /newsletter_subscribers/request_unsubscribe with the subscriber’s email in the body.
JWT bearer for the logged-in customer who owns the subscription. No token query param is needed in this path.

All failure modes return a generic invalid_token 422.

DELETE

api

store

newsletter_subscribers

{id}

Unsubscribe from the newsletter

const options = {method: 'DELETE', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/newsletter_subscribers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "code": "invalid_token",
    "message": "Newsletter unsubscribe token is invalid or has expired."
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Authorization

string

Optional Bearer JWT — alternative to the token query param

Path Parameters

string

required

Newsletter subscriber prefix id (sub_*)

Query Parameters

token

string

Unsubscribe token delivered to the subscriber by email (e.g. the link in an unsubscribe message).

Response

unsubscribed via JWT (owner)

⌘I

Unsubscribe from the newsletter

const options = {method: 'DELETE', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/newsletter_subscribers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "code": "invalid_token",
    "message": "Newsletter unsubscribe token is invalid or has expired."
  }
}

API basics

Endpoints

Unsubscribe from the newsletter

Authorizations

Headers

Path Parameters

Query Parameters

Response