← Documentation home
POST
/hyax-api/v1/people/one-click-unsubscribeOne-click unsubscribe
RFC 8058 style. Reads `email`, `teamId`, `token` from the **query string**. Same HMAC as unsubscribe-public.
Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.
Query parameters
| Name | Required | Description |
|---|---|---|
| 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/[email protected]&teamId=clx_team_id&token=%3Chex_hmac%3E'Example response
Shape varies by data; values are illustrative.
{
"success": true
}