Metorik Docs

Engage > Unsubscribes

Check unsubscribe status

Check whether an email address is unsubscribed.

GET /api/v1/store/engage/unsubscribe-status

Check unsubscribe status

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/engage/unsubscribe-status' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "unsubscribed": true
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • unsubscribed boolean