Create a segment
curl --request POST \
--url https://{domain}/api/v1/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Quiet VIPs",
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_tags": [
"<unknown>"
],
"min_days_inactive": 30,
"conditions": {
"match": "all",
"groups": [
{
"match": "any",
"rules": [
{
"field": "platform",
"op": "is",
"value": "whatsapp"
}
]
}
]
}
}
'import requests
url = "https://{domain}/api/v1/segments"
payload = {
"name": "Quiet VIPs",
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_tags": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude_tags": ["<unknown>"],
"min_days_inactive": 30,
"conditions": {
"match": "all",
"groups": [
{
"match": "any",
"rules": [
{
"field": "platform",
"op": "is",
"value": "whatsapp"
}
]
}
]
}
}
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({
name: 'Quiet VIPs',
stage: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_tags: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude_tags: ['<unknown>'],
min_days_inactive: 30,
conditions: {
match: 'all',
groups: [{match: 'any', rules: [{field: 'platform', op: 'is', value: 'whatsapp'}]}]
}
})
};
fetch('https://{domain}/api/v1/segments', 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://{domain}/api/v1/segments",
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([
'name' => 'Quiet VIPs',
'stage' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'include_tags' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'exclude_tags' => [
'<unknown>'
],
'min_days_inactive' => 30,
'conditions' => [
'match' => 'all',
'groups' => [
[
'match' => 'any',
'rules' => [
[
'field' => 'platform',
'op' => 'is',
'value' => 'whatsapp'
]
]
]
]
]
]),
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://{domain}/api/v1/segments"
payload := strings.NewReader("{\n \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\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://{domain}/api/v1/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/segments")
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 \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_bodySegments
Create a segment
Creates a saved filter. Tags are referenced by tag id. conditions is an optional grouped rule tree; unknown fields and operators are stripped by the shared sanitiser, so an invalid rule is dropped rather than silently matching everything.
Required permission: salesbot:contacts:write
POST
/
segments
Create a segment
curl --request POST \
--url https://{domain}/api/v1/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Quiet VIPs",
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude_tags": [
"<unknown>"
],
"min_days_inactive": 30,
"conditions": {
"match": "all",
"groups": [
{
"match": "any",
"rules": [
{
"field": "platform",
"op": "is",
"value": "whatsapp"
}
]
}
]
}
}
'import requests
url = "https://{domain}/api/v1/segments"
payload = {
"name": "Quiet VIPs",
"stage": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_tags": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude_tags": ["<unknown>"],
"min_days_inactive": 30,
"conditions": {
"match": "all",
"groups": [
{
"match": "any",
"rules": [
{
"field": "platform",
"op": "is",
"value": "whatsapp"
}
]
}
]
}
}
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({
name: 'Quiet VIPs',
stage: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_tags: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude_tags: ['<unknown>'],
min_days_inactive: 30,
conditions: {
match: 'all',
groups: [{match: 'any', rules: [{field: 'platform', op: 'is', value: 'whatsapp'}]}]
}
})
};
fetch('https://{domain}/api/v1/segments', 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://{domain}/api/v1/segments",
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([
'name' => 'Quiet VIPs',
'stage' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'include_tags' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'exclude_tags' => [
'<unknown>'
],
'min_days_inactive' => 30,
'conditions' => [
'match' => 'all',
'groups' => [
[
'match' => 'any',
'rules' => [
[
'field' => 'platform',
'op' => 'is',
'value' => 'whatsapp'
]
]
]
]
]
]),
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://{domain}/api/v1/segments"
payload := strings.NewReader("{\n \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\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://{domain}/api/v1/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v1/segments")
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 \"name\": \"Quiet VIPs\",\n \"stage\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude_tags\": [\n \"<unknown>\"\n ],\n \"min_days_inactive\": 30,\n \"conditions\": {\n \"match\": \"all\",\n \"groups\": [\n {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"platform\",\n \"op\": \"is\",\n \"value\": \"whatsapp\"\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
bearerAuthapiKeyHeader
A workspace API key: Authorization: Bearer osk_...
Body
application/json
Response
201
Created