Skip to main content
POST
/
newsletter
/
unsubscribe
Unsubscribe
curl --request POST \
  --url https://store.salesive.com/api/v1/newsletter/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "email": "[email protected]"
}
'

​
Request

POST /newsletter/unsubscribe
x-shop-id: {{shopId}}
Content-Type: application/json

{
  "email": "[email protected]"
}

​
Headers

HeaderTypeDescription
x-shop-idstringIdentify the shop.
Content-TypestringAlways set to application/json.

​
Body parameters

FieldTypeRequiredDescription
emailstringYesEmail address to unsubscribe.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Unsubscribed successfully",
    "data": {
        "email": "[email protected]",
        "unsubscribedAt": "2025-01-18T12:20:00.000Z"
    }
}

​
Error response

{
    "status": 404,
    "success": false,
    "message": "Subscription not found",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
​
email
string<email>
required

Response

200

Unsubscribed successfully