POST
/hyax-api/v1/people/addCreate or update person
Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.
Request body
| Field | Required | Description |
|---|---|---|
email | Required | Trimmed, lowercased |
name | No | Display name |
tags | No | String array; merged with existing on update |
source | No | Signup source (default `API` on create) |
purchaseValue | No | Number; validation error if NaN |
phone | No | |
address1 | No | |
address2 | No | |
city | No | |
state | No | |
zipCode | No | |
country | No | |
notes | No | Stored in metadata |
ip | No | Override inferred client IP; stored in metadata |
referrer | No | Max 1000 chars |
utm_source | No | Max 200 chars |
utm_medium | No | Max 200 chars |
utm_campaign | No | Max 200 chars |
utm_content | No | Max 200 chars |
utm_term | No | Max 200 chars |
keyword | No | Max 200 chars |
Request
curl -X POST 'https://platform.hyax.com/hyax-api/v1/people/add' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"email": "[email protected]",
"name": "Ada Lovelace",
"tags": [
"newsletter",
"vip"
],
"source": "Landing page",
"purchaseValue": 0,
"phone": "+1-555-0100",
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"zipCode": "94105",
"country": "US",
"notes": "VIP customer",
"ip": "203.0.113.42",
"referrer": "https://google.com",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring-sale",
"utm_content": "hero-banner",
"utm_term": "saas tools",
"keyword": "email marketing"
}'Response
{
"success": true,
"message": "Person created",
"data": {
"id": "clx…",
"email": "[email protected]",
"name": "Ada Lovelace",
"tags": ["newsletter", "vip"],
"signupSource": "Landing page",
"metadata": null,
"purchaseValue": 0,
"isNew": true
}
}