Create a contact segment

curl --request POST \
  --url http://localhost:8080/contacts/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": {
    "or": [
      {
        "and": [
          {
            "type": "all_contacts"
          }
        ]
      }
    ]
  },
  "description": "<string>"
}
'

import requests

url = "http://localhost:8080/contacts/segments"

payload = {
    "name": "<string>",
    "definition": { "or": [{ "and": [{ "type": "all_contacts" }] }] },
    "description": "<string>"
}
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: '<string>',
    definition: {or: [{and: [{type: 'all_contacts'}]}]},
    description: '<string>'
  })
};

fetch('http://localhost:8080/contacts/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/contacts/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' => '<string>',
    'definition' => [
        'or' => [
                [
                                'and' => [
                                                                [
                                                                                                                                'type' => 'all_contacts'
                                                                ]
                                ]
                ]
        ]
    ],
    'description' => '<string>'
  ]),
  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 := "http://localhost:8080/contacts/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\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("http://localhost:8080/contacts/segments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/contacts/segments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "definition": {
    "or": [
      {
        "and": [
          {
            "type": "all_contacts"
          }
        ]
      }
    ]
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

POST

contacts

segments

Create a contact segment

curl --request POST \
  --url http://localhost:8080/contacts/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": {
    "or": [
      {
        "and": [
          {
            "type": "all_contacts"
          }
        ]
      }
    ]
  },
  "description": "<string>"
}
'

import requests

url = "http://localhost:8080/contacts/segments"

payload = {
    "name": "<string>",
    "definition": { "or": [{ "and": [{ "type": "all_contacts" }] }] },
    "description": "<string>"
}
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: '<string>',
    definition: {or: [{and: [{type: 'all_contacts'}]}]},
    description: '<string>'
  })
};

fetch('http://localhost:8080/contacts/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/contacts/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' => '<string>',
    'definition' => [
        'or' => [
                [
                                'and' => [
                                                                [
                                                                                                                                'type' => 'all_contacts'
                                                                ]
                                ]
                ]
        ]
    ],
    'description' => '<string>'
  ]),
  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 := "http://localhost:8080/contacts/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\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("http://localhost:8080/contacts/segments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/contacts/segments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  },\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "definition": {
    "or": [
      {
        "and": [
          {
            "type": "all_contacts"
          }
        ]
      }
    ]
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Requires segments:write. Supply name and definition. Omit description to use null. Membership is calculated in the background. A null definition matches all contacts. See contact segment guidance for filter examples and membership timing.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

definition

object | null

required

Show child attributes

description

string | null

Optional description; defaults to null

Response

Default Response

string

required

name

string

required

description

string | null

required

definition

object | null

required

Show child attributes

created_at

string | null

required

ISO 8601 timestamp of when the segment was created

updated_at

string | null

required

ISO 8601 timestamp of when the segment was last updated

Overview

Blocklist

Autopilot

Organization

Contacts

Companies

Sessions

Connect

AI Phone Agents

Classical IVR

AI Email

AI WhatsApp

AI Actions

Sequences

Outbound Blocklist

Media

AI Training

Help Center

Resource Usage

Customer Insights

Teams

CSAT

Redaction

Crawl

Tags

Custom Statuses

Inbox Views

Office Hours

Handoff Analytics

SLA Analytics

Secrets

Audit Logs

Workflows (Beta)

Salesforce MIAW

Webhooks

Create a contact segment

Authorizations

Body

Response