← Documentation home
POST/hyax-api/v1/people/tags/remove

Remove tags

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

Request body

FieldRequiredDescription
emailYes
tagsYesNon-empty string array

Request examples

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

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

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "message": "Tags removed successfully",
  "data": {
    "id": "clx…",
    "email": "[email protected]",
    "tags": ["newsletter"],
    "removedTags": ["beta"]
  }
}