Customer CDP
Preview audience customers
Requires contacts:read, Customer CDP and Audiences. The preview is read-only and limited to accessible contacts.
POST
/
api
/
v2
/
accounts
/
{accountId}
/
cdp
/
audiences
/
preview
Preview audience customers
curl --request POST \
--url https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
1042,
1088
],
"match": "all",
"mode": "dynamic",
"rules": [
{
"field": "country",
"operator": "eq",
"value": "SA"
}
]
}
'import requests
url = "https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview"
payload = {
"contact_ids": [1042, 1088],
"match": "all",
"mode": "dynamic",
"rules": [
{
"field": "country",
"operator": "eq",
"value": "SA"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
contact_ids: [1042, 1088],
match: 'all',
mode: 'dynamic',
rules: [{field: 'country', operator: 'eq', value: 'SA'}]
})
};
fetch('https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview', 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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview",
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([
'contact_ids' => [
1042,
1088
],
'match' => 'all',
'mode' => 'dynamic',
'rules' => [
[
'field' => 'country',
'operator' => 'eq',
'value' => 'SA'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview"
payload := strings.NewReader("{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview")
.header("Content-Type", "application/json")
.body("{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}Path Parameters
HueChat account ID
Query Parameters
Page number
Required range:
1 <= x <= 100000Records per page
Required range:
1 <= x <= 100Body
application/json
Unsaved audience conditions
Response
OK
The response is of type object.
⌘I
Preview audience customers
curl --request POST \
--url https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
1042,
1088
],
"match": "all",
"mode": "dynamic",
"rules": [
{
"field": "country",
"operator": "eq",
"value": "SA"
}
]
}
'import requests
url = "https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview"
payload = {
"contact_ids": [1042, 1088],
"match": "all",
"mode": "dynamic",
"rules": [
{
"field": "country",
"operator": "eq",
"value": "SA"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
contact_ids: [1042, 1088],
match: 'all',
mode: 'dynamic',
rules: [{field: 'country', operator: 'eq', value: 'SA'}]
})
};
fetch('https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview', 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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview",
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([
'contact_ids' => [
1042,
1088
],
'match' => 'all',
'mode' => 'dynamic',
'rules' => [
[
'field' => 'country',
'operator' => 'eq',
'value' => 'SA'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview"
payload := strings.NewReader("{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview")
.header("Content-Type", "application/json")
.body("{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.huechat.ai/api/v2/accounts/{accountId}/cdp/audiences/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_ids\": [\n 1042,\n 1088\n ],\n \"match\": \"all\",\n \"mode\": \"dynamic\",\n \"rules\": [\n {\n \"field\": \"country\",\n \"operator\": \"eq\",\n \"value\": \"SA\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}{
"code": "plan_disabled",
"error": "Record not found or unavailable",
"feature": "customer_cdp"
}
