curl --request POST \
--url https://app.livechatai.com/api/v2/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "clx1234567890abcdef",
"distinctId": "user_12345",
"contactId": "contact_1234567890",
"userHash": "abc123hash",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"attributes": {
"planType": "premium",
"userLevel": "advanced",
"signupDate": "2024-01-15"
}
}
'import requests
url = "https://app.livechatai.com/api/v2/contacts"
payload = {
"agentId": "clx1234567890abcdef",
"distinctId": "user_12345",
"contactId": "contact_1234567890",
"userHash": "abc123hash",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"attributes": {
"planType": "premium",
"userLevel": "advanced",
"signupDate": "2024-01-15"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: 'clx1234567890abcdef',
distinctId: 'user_12345',
contactId: 'contact_1234567890',
userHash: 'abc123hash',
name: 'John Doe',
email: 'john@example.com',
phone: '+1234567890',
attributes: {planType: 'premium', userLevel: 'advanced', signupDate: '2024-01-15'}
})
};
fetch('https://app.livechatai.com/api/v2/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.livechatai.com/api/v2/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => 'clx1234567890abcdef',
'distinctId' => 'user_12345',
'contactId' => 'contact_1234567890',
'userHash' => 'abc123hash',
'name' => 'John Doe',
'email' => 'john@example.com',
'phone' => '+1234567890',
'attributes' => [
'planType' => 'premium',
'userLevel' => 'advanced',
'signupDate' => '2024-01-15'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.livechatai.com/api/v2/contacts"
payload := strings.NewReader("{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.livechatai.com/api/v2/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.livechatai.com/api/v2/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"contactId": "contact_1234567890"
}Create or update a contact
Create or update a contact for a specific agent. This endpoint allows you to identify users and associate them with chat sessions, enabling personalized experiences and contact tracking.
curl --request POST \
--url https://app.livechatai.com/api/v2/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "clx1234567890abcdef",
"distinctId": "user_12345",
"contactId": "contact_1234567890",
"userHash": "abc123hash",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"attributes": {
"planType": "premium",
"userLevel": "advanced",
"signupDate": "2024-01-15"
}
}
'import requests
url = "https://app.livechatai.com/api/v2/contacts"
payload = {
"agentId": "clx1234567890abcdef",
"distinctId": "user_12345",
"contactId": "contact_1234567890",
"userHash": "abc123hash",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"attributes": {
"planType": "premium",
"userLevel": "advanced",
"signupDate": "2024-01-15"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: 'clx1234567890abcdef',
distinctId: 'user_12345',
contactId: 'contact_1234567890',
userHash: 'abc123hash',
name: 'John Doe',
email: 'john@example.com',
phone: '+1234567890',
attributes: {planType: 'premium', userLevel: 'advanced', signupDate: '2024-01-15'}
})
};
fetch('https://app.livechatai.com/api/v2/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.livechatai.com/api/v2/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => 'clx1234567890abcdef',
'distinctId' => 'user_12345',
'contactId' => 'contact_1234567890',
'userHash' => 'abc123hash',
'name' => 'John Doe',
'email' => 'john@example.com',
'phone' => '+1234567890',
'attributes' => [
'planType' => 'premium',
'userLevel' => 'advanced',
'signupDate' => '2024-01-15'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.livechatai.com/api/v2/contacts"
payload := strings.NewReader("{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.livechatai.com/api/v2/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.livechatai.com/api/v2/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"clx1234567890abcdef\",\n \"distinctId\": \"user_12345\",\n \"contactId\": \"contact_1234567890\",\n \"userHash\": \"abc123hash\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"attributes\": {\n \"planType\": \"premium\",\n \"userLevel\": \"advanced\",\n \"signupDate\": \"2024-01-15\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"contactId": "contact_1234567890"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Contact creation or identification details.
Unique identifier of the agent
"clx1234567890abcdef"
Unique identifier for the user/contact
"user_12345"
Optional: Existing contact ID to update
"contact_1234567890"
Required if secure identification is enabled for the agent.
"abc123hash"
Full name of the contact
"John Doe"
Email address of the contact
"john@example.com"
Phone number of the contact
"+1234567890"
Custom attributes to associate with the contact. Only allowed attributes configured for the agent will be saved.
{
"planType": "premium",
"userLevel": "advanced",
"signupDate": "2024-01-15"
}

