Skip to main content
GET
/
newsletter
/
check
Check subscription
curl --request GET \
  --url https://store.salesive.com/api/v1/newsletter/check \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'

​
Request

GET /newsletter/check?email=test@example.com
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
x-shop-idstringIdentify the shop.

​
Query parameters

ParameterTypeRequiredDescription
emailstringYesEmail address to check.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Subscription status retrieved",
    "data": {
        "isSubscribed": true,
        "exists": true
    }
}

​
Not subscribed response

{
    "status": 200,
    "success": true,
    "message": "Subscription status retrieved",
    "data": {
        "isSubscribed": false,
        "exists": false
    }
}

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.

Query Parameters

​
email
string<email>
required

Response

200

Subscription status retrieved