Check whether an address is unsubscribed

Returns the unsubscribe record for an address. A 404 means the address is not unsubscribed and currently receives email. Matching is case-insensitive.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Path Parameters

emailRequiredstring

Email address, URL-encoded

Format: "email"

curl -X GET "https://clientsphere.io/api/v1/email-unsubscribes/user@example.com" \
  -H "Authorization: Bearer <token>"

The address is unsubscribed

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "email": "user@example.com",
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "source": "website",
    "reason": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

Check whether an address is unsubscribed

Authorization

Path Parameters

Response

TypeScript