PATCH/hyax-api/v1/people/:id

Update person

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

Request body

Field	Required	Description
name	No	Display name
email	No	Email address (trimmed, lowercased)
category	No	`LEAD` \| `CUSTOMER` \| `CANCELLED` (CANCELLED unsubscribes)
tags	No	Array of tag strings (replaces all tags)
phone	No	Phone number
address1	No	Street address line 1
address2	No	Street address line 2
city	No	City
state	No	State / province
zipCode	No	Postal code
country	No	Country

Request examples

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

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/people/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "email": "[email protected]",
    "name": "Ada Lovelace",
    "category": "LEAD",
    "tags": ["newsletter", "vip"],
    "updatedAt": "2025-01-15T12:00:00.000Z"
  }
}