Create contact
curl --request POST \
--url https://{your-subdomain}.neetochat.com/api/external/v2/visitors \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "crm-user-123",
"traits": {
"plan": "Pro",
"country": "US"
},
"field_values_attributes": [
{
"field_id": "7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f",
"data": {
"value": "Enterprise"
}
}
]
}
'const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
Accept: '<accept>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Sam Brown',
email: 'sam@example.com',
phone_number: '+14155550123',
user_identifier: 'crm-user-123',
traits: {plan: 'Pro', country: 'US'},
field_values_attributes: [
{field_id: '7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f', data: {value: 'Enterprise'}}
]
})
};
fetch('https://{your-subdomain}.neetochat.com/api/external/v2/visitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetochat.com/api/external/v2/visitors"
payload = {
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "crm-user-123",
"traits": {
"plan": "Pro",
"country": "US"
},
"field_values_attributes": [
{
"field_id": "7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f",
"data": { "value": "Enterprise" }
}
]
}
headers = {
"X-Api-Key": "<x-api-key>",
"Accept": "<accept>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contact": {
"id": "2c79a334-0bc8-44e4-9504-331f59d400ab",
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "customer-1042",
"traits": {
"plan": "Pro"
},
"created_at": "2026-10-08T14:35:46.785Z",
"updated_at": "2026-10-08T14:35:46.785Z",
"field_values": [
{
"field_id": "bac73249-2ef5-46f6-b80d-78271914c2a6",
"field_name": "Plan tier",
"value": "Enterprise"
}
]
}
}Contacts
Create contact
Add a contact to the workspace.
POST
/
visitors
Create contact
curl --request POST \
--url https://{your-subdomain}.neetochat.com/api/external/v2/visitors \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "crm-user-123",
"traits": {
"plan": "Pro",
"country": "US"
},
"field_values_attributes": [
{
"field_id": "7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f",
"data": {
"value": "Enterprise"
}
}
]
}
'const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
Accept: '<accept>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Sam Brown',
email: 'sam@example.com',
phone_number: '+14155550123',
user_identifier: 'crm-user-123',
traits: {plan: 'Pro', country: 'US'},
field_values_attributes: [
{field_id: '7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f', data: {value: 'Enterprise'}}
]
})
};
fetch('https://{your-subdomain}.neetochat.com/api/external/v2/visitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetochat.com/api/external/v2/visitors"
payload = {
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "crm-user-123",
"traits": {
"plan": "Pro",
"country": "US"
},
"field_values_attributes": [
{
"field_id": "7f1f1f36-1f0f-4a0e-9b1f-2b0f3c4d5e6f",
"data": { "value": "Enterprise" }
}
]
}
headers = {
"X-Api-Key": "<x-api-key>",
"Accept": "<accept>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contact": {
"id": "2c79a334-0bc8-44e4-9504-331f59d400ab",
"name": "Sam Brown",
"email": "sam@example.com",
"phone_number": "+14155550123",
"user_identifier": "customer-1042",
"traits": {
"plan": "Pro"
},
"created_at": "2026-10-08T14:35:46.785Z",
"updated_at": "2026-10-08T14:35:46.785Z",
"field_values": [
{
"field_id": "bac73249-2ef5-46f6-b80d-78271914c2a6",
"field_name": "Plan tier",
"value": "Enterprise"
}
]
}
}Replace
Learn how to find your subdomain in Workspace subdomain.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Body
application/json
Values for the contact fields configured in your workspace, under Settings > Contact fields. Every field_id must be a contact field of your workspace, otherwise nothing is created.
Hide child attributes
Hide child attributes
The field's value, under a value key.
The accepted type follows the field's kind. A text field takes a string, a number field takes a number or a string that reads as one, and a date and time field takes an ISO 8601 string. A value the field's kind does not accept, or a number outside a range configured on the field, rejects the whole request.
Example:
{ "value": "Enterprise" }
Response
Created - Contact created successfully
Hide child attributes
Hide child attributes
Values the contact holds for the workspace's contact fields. Fields without a value are left out.
Hide child attributes
Hide child attributes