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`	Required
`teamId`	Required
`token`	Required	Hex HMAC-SHA256 of `email:teamId`

Request

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>"
  }'

Response

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

Request

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>"
  }'

Response

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