curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/update_customer \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"name": "Thomas Anderson",
"email": "t.anderson@example.com",
"suggested_email": "t.anderson@example.com",
"avatar": "https://example.com/avatars/1.png",
"phone_number": "+18008529001",
"session_fields": [
{
"custom_key": "custom_value"
},
{
"another_custom_key": "another_custom_value"
}
],
"omnichannel": {
"fbmessenger": {
"id": "1234567890",
"name": "Thomas Anderson",
"first_name": "Thomas",
"last_name": "Anderson",
"profile_pic": "https://example.com/avatars/1.png",
"gender": "male",
"locale": "en_US",
"is_verified_user": true
},
"twilio": {
"phone_number": "+18008529001"
},
"whatsapp": {
"id": "15550000001",
"name": "Thomas Anderson",
"phone_number": "+15550000001"
}
},
"address": {
"address": "1600 Pennsylvania Avenue NW",
"city": "Washington",
"country": "United States",
"state": "DC",
"postal_code": "20500"
}
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/update_customer"
payload = {
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"name": "Thomas Anderson",
"email": "t.anderson@example.com",
"suggested_email": "t.anderson@example.com",
"avatar": "https://example.com/avatars/1.png",
"phone_number": "+18008529001",
"session_fields": [{ "custom_key": "custom_value" }, { "another_custom_key": "another_custom_value" }],
"omnichannel": {
"fbmessenger": {
"id": "1234567890",
"name": "Thomas Anderson",
"first_name": "Thomas",
"last_name": "Anderson",
"profile_pic": "https://example.com/avatars/1.png",
"gender": "male",
"locale": "en_US",
"is_verified_user": True
},
"twilio": { "phone_number": "+18008529001" },
"whatsapp": {
"id": "15550000001",
"name": "Thomas Anderson",
"phone_number": "+15550000001"
}
},
"address": {
"address": "1600 Pennsylvania Avenue NW",
"city": "Washington",
"country": "United States",
"state": "DC",
"postal_code": "20500"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'b7eff798-f8df-4364-8059-649c35c9ed0c',
name: 'Thomas Anderson',
email: 't.anderson@example.com',
suggested_email: 't.anderson@example.com',
avatar: 'https://example.com/avatars/1.png',
phone_number: '+18008529001',
session_fields: [{custom_key: 'custom_value'}, {another_custom_key: 'another_custom_value'}],
omnichannel: {
fbmessenger: {
id: '1234567890',
name: 'Thomas Anderson',
first_name: 'Thomas',
last_name: 'Anderson',
profile_pic: 'https://example.com/avatars/1.png',
gender: 'male',
locale: 'en_US',
is_verified_user: true
},
twilio: {phone_number: '+18008529001'},
whatsapp: {id: '15550000001', name: 'Thomas Anderson', phone_number: '+15550000001'}
},
address: {
address: '1600 Pennsylvania Avenue NW',
city: 'Washington',
country: 'United States',
state: 'DC',
postal_code: '20500'
}
})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/update_customer', 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://api.livechatinc.com/v3.7/agent/action/update_customer",
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([
'id' => 'b7eff798-f8df-4364-8059-649c35c9ed0c',
'name' => 'Thomas Anderson',
'email' => 't.anderson@example.com',
'suggested_email' => 't.anderson@example.com',
'avatar' => 'https://example.com/avatars/1.png',
'phone_number' => '+18008529001',
'session_fields' => [
[
'custom_key' => 'custom_value'
],
[
'another_custom_key' => 'another_custom_value'
]
],
'omnichannel' => [
'fbmessenger' => [
'id' => '1234567890',
'name' => 'Thomas Anderson',
'first_name' => 'Thomas',
'last_name' => 'Anderson',
'profile_pic' => 'https://example.com/avatars/1.png',
'gender' => 'male',
'locale' => 'en_US',
'is_verified_user' => true
],
'twilio' => [
'phone_number' => '+18008529001'
],
'whatsapp' => [
'id' => '15550000001',
'name' => 'Thomas Anderson',
'phone_number' => '+15550000001'
]
],
'address' => [
'address' => '1600 Pennsylvania Avenue NW',
'city' => 'Washington',
'country' => 'United States',
'state' => 'DC',
'postal_code' => '20500'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api.livechatinc.com/v3.7/agent/action/update_customer"
payload := strings.NewReader("{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.livechatinc.com/v3.7/agent/action/update_customer")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/update_customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}"
response = http.request(request)
puts response.read_bodyUpdate customer
Updates the customer’s fields.
You can clear name, email, phone_number, suggested_email, and address by providing an empty string as the field value.
curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/update_customer \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"name": "Thomas Anderson",
"email": "t.anderson@example.com",
"suggested_email": "t.anderson@example.com",
"avatar": "https://example.com/avatars/1.png",
"phone_number": "+18008529001",
"session_fields": [
{
"custom_key": "custom_value"
},
{
"another_custom_key": "another_custom_value"
}
],
"omnichannel": {
"fbmessenger": {
"id": "1234567890",
"name": "Thomas Anderson",
"first_name": "Thomas",
"last_name": "Anderson",
"profile_pic": "https://example.com/avatars/1.png",
"gender": "male",
"locale": "en_US",
"is_verified_user": true
},
"twilio": {
"phone_number": "+18008529001"
},
"whatsapp": {
"id": "15550000001",
"name": "Thomas Anderson",
"phone_number": "+15550000001"
}
},
"address": {
"address": "1600 Pennsylvania Avenue NW",
"city": "Washington",
"country": "United States",
"state": "DC",
"postal_code": "20500"
}
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/update_customer"
payload = {
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"name": "Thomas Anderson",
"email": "t.anderson@example.com",
"suggested_email": "t.anderson@example.com",
"avatar": "https://example.com/avatars/1.png",
"phone_number": "+18008529001",
"session_fields": [{ "custom_key": "custom_value" }, { "another_custom_key": "another_custom_value" }],
"omnichannel": {
"fbmessenger": {
"id": "1234567890",
"name": "Thomas Anderson",
"first_name": "Thomas",
"last_name": "Anderson",
"profile_pic": "https://example.com/avatars/1.png",
"gender": "male",
"locale": "en_US",
"is_verified_user": True
},
"twilio": { "phone_number": "+18008529001" },
"whatsapp": {
"id": "15550000001",
"name": "Thomas Anderson",
"phone_number": "+15550000001"
}
},
"address": {
"address": "1600 Pennsylvania Avenue NW",
"city": "Washington",
"country": "United States",
"state": "DC",
"postal_code": "20500"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'b7eff798-f8df-4364-8059-649c35c9ed0c',
name: 'Thomas Anderson',
email: 't.anderson@example.com',
suggested_email: 't.anderson@example.com',
avatar: 'https://example.com/avatars/1.png',
phone_number: '+18008529001',
session_fields: [{custom_key: 'custom_value'}, {another_custom_key: 'another_custom_value'}],
omnichannel: {
fbmessenger: {
id: '1234567890',
name: 'Thomas Anderson',
first_name: 'Thomas',
last_name: 'Anderson',
profile_pic: 'https://example.com/avatars/1.png',
gender: 'male',
locale: 'en_US',
is_verified_user: true
},
twilio: {phone_number: '+18008529001'},
whatsapp: {id: '15550000001', name: 'Thomas Anderson', phone_number: '+15550000001'}
},
address: {
address: '1600 Pennsylvania Avenue NW',
city: 'Washington',
country: 'United States',
state: 'DC',
postal_code: '20500'
}
})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/update_customer', 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://api.livechatinc.com/v3.7/agent/action/update_customer",
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([
'id' => 'b7eff798-f8df-4364-8059-649c35c9ed0c',
'name' => 'Thomas Anderson',
'email' => 't.anderson@example.com',
'suggested_email' => 't.anderson@example.com',
'avatar' => 'https://example.com/avatars/1.png',
'phone_number' => '+18008529001',
'session_fields' => [
[
'custom_key' => 'custom_value'
],
[
'another_custom_key' => 'another_custom_value'
]
],
'omnichannel' => [
'fbmessenger' => [
'id' => '1234567890',
'name' => 'Thomas Anderson',
'first_name' => 'Thomas',
'last_name' => 'Anderson',
'profile_pic' => 'https://example.com/avatars/1.png',
'gender' => 'male',
'locale' => 'en_US',
'is_verified_user' => true
],
'twilio' => [
'phone_number' => '+18008529001'
],
'whatsapp' => [
'id' => '15550000001',
'name' => 'Thomas Anderson',
'phone_number' => '+15550000001'
]
],
'address' => [
'address' => '1600 Pennsylvania Avenue NW',
'city' => 'Washington',
'country' => 'United States',
'state' => 'DC',
'postal_code' => '20500'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api.livechatinc.com/v3.7/agent/action/update_customer"
payload := strings.NewReader("{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.livechatinc.com/v3.7/agent/action/update_customer")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/update_customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"b7eff798-f8df-4364-8059-649c35c9ed0c\",\n \"name\": \"Thomas Anderson\",\n \"email\": \"t.anderson@example.com\",\n \"suggested_email\": \"t.anderson@example.com\",\n \"avatar\": \"https://example.com/avatars/1.png\",\n \"phone_number\": \"+18008529001\",\n \"session_fields\": [\n {\n \"custom_key\": \"custom_value\"\n },\n {\n \"another_custom_key\": \"another_custom_value\"\n }\n ],\n \"omnichannel\": {\n \"fbmessenger\": {\n \"id\": \"1234567890\",\n \"name\": \"Thomas Anderson\",\n \"first_name\": \"Thomas\",\n \"last_name\": \"Anderson\",\n \"profile_pic\": \"https://example.com/avatars/1.png\",\n \"gender\": \"male\",\n \"locale\": \"en_US\",\n \"is_verified_user\": true\n },\n \"twilio\": {\n \"phone_number\": \"+18008529001\"\n },\n \"whatsapp\": {\n \"id\": \"15550000001\",\n \"name\": \"Thomas Anderson\",\n \"phone_number\": \"+15550000001\"\n }\n },\n \"address\": {\n \"address\": \"1600 Pennsylvania Avenue NW\",\n \"city\": \"Washington\",\n \"country\": \"United States\",\n \"state\": \"DC\",\n \"postal_code\": \"20500\"\n }\n}"
response = http.request(request)
puts response.read_bodycustomers:rwAuthorizations
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
The customer ID. The UUID v4 format is required.
The customer's name.
The customer's email.
The email address suggested for the customer based on tracked activity, such as a form submission. The customer has not confirmed this address. This field is independent of email. An empty value clears only the suggestion.
The URL of the customer's avatar.
The customer's phone number in E.164 format.
An array of custom object-enclosed key-value pairs. Respects the order of items.
The customer's omnichannel data.
Show child attributes
Show child attributes
The customer's address. Provide an empty string to clear it.
Show child attributes
Show child attributes
Response
Customer updated.
Was this page helpful?