← Documentation home
POST/hyax-api/v1/people/unsubscribe

Unsubscribe (API key)

Returns 200 even if the person was already unsubscribed or never subscribed. Check `wasSubscribed` to tell.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

FieldRequiredDescription
emailYes

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl). 

curl -X POST 'https://platform.hyax.com/hyax-api/v1/people/unsubscribe' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "[email protected]"
  }'

Example response

Shape varies by data; values are illustrative. 

{
  "success": true,
  "message": "Person unsubscribed successfully",
  "data": { "id": "clx…", "email": "[email protected]", "wasSubscribed": true }
}