POST/hyax-api/v1/people/unsubscribe-public

Unsubscribe (token, JSON body)

HMAC-SHA256 token signs the string `${email}:${teamId}`.

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

Request body

Field	Required	Description
email	Yes
teamId	Yes
token	Yes	Hex HMAC-SHA256 of `email:teamId`

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-public' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "[email protected]",
    "teamId": "clx_team_id",
    "token": "<hex_hmac>"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "message": "You have been successfully unsubscribed."
}