curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"contact": {
"name": "Maria Silva",
"email": "maria.silva@example.com",
"phone_number": "+5511987654321",
"identifier": "crm-4821",
"custom_attributes": {
"plan": "pro"
}
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}"
payload = { "contact": {
"name": "Maria Silva",
"email": "maria.silva@example.com",
"phone_number": "+5511987654321",
"identifier": "crm-4821",
"custom_attributes": { "plan": "pro" }
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contact: {
name: 'Maria Silva',
email: 'maria.silva@example.com',
phone_number: '+5511987654321',
identifier: 'crm-4821',
custom_attributes: {plan: 'pro'}
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'contact' => [
'name' => 'Maria Silva',
'email' => 'maria.silva@example.com',
'phone_number' => '+5511987654321',
'identifier' => 'crm-4821',
'custom_attributes' => [
'plan' => 'pro'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}"
payload := strings.NewReader("{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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.patch("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 815,
"name": "Jane Doe",
"email": "jane@example.com",
"phone_number": "+5511999998888",
"identifier": "crm-42",
"custom_attributes": {
"plan": "pro"
},
"created_at": "2026-09-02T14:03:11.215Z",
"last_activity_at": "2026-10-20T09:41:27.000Z"
}{
"error": {
"code": "bad_request",
"message": "Provide at least one of name, email, phone_number, identifier or custom_attributes."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "Contact data is available to account administrators only. Ask an administrator of this account to run this request."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "conflict",
"message": "Conflict",
"details": [
{
"field": "email",
"code": "duplicate",
"message": "Another contact in this account already has this email; its id is 815. Nothing was created: call updateContact with that id to change it.",
"existing_contact_id": 815
}
]
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "email",
"code": "invalid",
"message": "is invalid"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Update a contact
Changes the name, email, phone number, identifier or custom attributes of a contact. Send only what you mean to change: a field you leave out keeps its current value. The body is wrapped in contact, and at least one of its fields must be present — an empty one is a 400, not a no-op.
custom_attributes is merged into the values already stored: keys you do not send are kept, and a key sent as null is removed.
email, phone_number and identifier can be replaced but not cleared: sending one as null or empty is a 422 and nothing is saved, so leave it out to keep it. name cannot be blank either. Changing one of them to a value another contact of the account already has is a 409, the same answer as creating a contact that already exists: error.details[0].field says which value repeats and error.details[0].existing_contact_id is the contact that already has it. Nothing is saved.
A contact of another account answers 404, the same as an id that does not exist. Only account administrators can update contacts through this API.
curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"contact": {
"name": "Maria Silva",
"email": "maria.silva@example.com",
"phone_number": "+5511987654321",
"identifier": "crm-4821",
"custom_attributes": {
"plan": "pro"
}
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}"
payload = { "contact": {
"name": "Maria Silva",
"email": "maria.silva@example.com",
"phone_number": "+5511987654321",
"identifier": "crm-4821",
"custom_attributes": { "plan": "pro" }
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contact: {
name: 'Maria Silva',
email: 'maria.silva@example.com',
phone_number: '+5511987654321',
identifier: 'crm-4821',
custom_attributes: {plan: 'pro'}
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'contact' => [
'name' => 'Maria Silva',
'email' => 'maria.silva@example.com',
'phone_number' => '+5511987654321',
'identifier' => 'crm-4821',
'custom_attributes' => [
'plan' => 'pro'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}"
payload := strings.NewReader("{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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.patch("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact\": {\n \"name\": \"Maria Silva\",\n \"email\": \"maria.silva@example.com\",\n \"phone_number\": \"+5511987654321\",\n \"identifier\": \"crm-4821\",\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 815,
"name": "Jane Doe",
"email": "jane@example.com",
"phone_number": "+5511999998888",
"identifier": "crm-42",
"custom_attributes": {
"plan": "pro"
},
"created_at": "2026-09-02T14:03:11.215Z",
"last_activity_at": "2026-10-20T09:41:27.000Z"
}{
"error": {
"code": "bad_request",
"message": "Provide at least one of name, email, phone_number, identifier or custom_attributes."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "Contact data is available to account administrators only. Ask an administrator of this account to run this request."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "conflict",
"message": "Conflict",
"details": [
{
"field": "email",
"code": "duplicate",
"message": "Another contact in this account already has this email; its id is 815. Nothing was created: call updateContact with that id to change it.",
"existing_contact_id": 815
}
]
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "email",
"code": "invalid",
"message": "is invalid"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Authorizations
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
Body
Response
The contact after the update.
A customer contact of the account.