Create segment definition

curl --request POST \
  --url https://api.text.com/cdp/v1/create_segment_definition \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "name_set"
      },
      {
        "type": "customer_property_set",
        "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
      }
    ]
  }
}
'

import requests

url = "https://api.text.com/cdp/v1/create_segment_definition"

payload = { "definition": {
        "type": "and",
        "nodes": [
            { "type": "name_set" },
            {
                "type": "customer_property_set",
                "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
            }
        ]
    } }
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({
    definition: {
      type: 'and',
      nodes: [
        {type: 'name_set'},
        {
          type: 'customer_property_set',
          customer_property_id: '9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11'
        }
      ]
    }
  })
};

fetch('https://api.text.com/cdp/v1/create_segment_definition', 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.text.com/cdp/v1/create_segment_definition",
  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([
    'definition' => [
        'type' => 'and',
        'nodes' => [
                [
                                'type' => 'name_set'
                ],
                [
                                'type' => 'customer_property_set',
                                'customer_property_id' => '9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11'
                ]
        ]
    ]
  ]),
  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.text.com/cdp/v1/create_segment_definition"

	payload := strings.NewReader("{\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\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.text.com/cdp/v1/create_segment_definition")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.text.com/cdp/v1/create_segment_definition")

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  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\n  }\n}"

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

{
  "segment_id": 2,
  "segment_type": "custom",
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "name_set"
      },
      {
        "type": "customer_property_set",
        "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
      }
    ]
  },
  "referenced_customer_properties_definitions_ids": [
    "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
  ],
  "last_updated_at": "2026-08-08T10:15:00Z",
  "agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
  "agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}

POST

create_segment_definition

Create segment definition

curl --request POST \
  --url https://api.text.com/cdp/v1/create_segment_definition \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "name_set"
      },
      {
        "type": "customer_property_set",
        "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
      }
    ]
  }
}
'

import requests

url = "https://api.text.com/cdp/v1/create_segment_definition"

payload = { "definition": {
        "type": "and",
        "nodes": [
            { "type": "name_set" },
            {
                "type": "customer_property_set",
                "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
            }
        ]
    } }
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({
    definition: {
      type: 'and',
      nodes: [
        {type: 'name_set'},
        {
          type: 'customer_property_set',
          customer_property_id: '9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11'
        }
      ]
    }
  })
};

fetch('https://api.text.com/cdp/v1/create_segment_definition', 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.text.com/cdp/v1/create_segment_definition",
  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([
    'definition' => [
        'type' => 'and',
        'nodes' => [
                [
                                'type' => 'name_set'
                ],
                [
                                'type' => 'customer_property_set',
                                'customer_property_id' => '9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11'
                ]
        ]
    ]
  ]),
  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.text.com/cdp/v1/create_segment_definition"

	payload := strings.NewReader("{\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\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.text.com/cdp/v1/create_segment_definition")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.text.com/cdp/v1/create_segment_definition")

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  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"name_set\"\n      },\n      {\n        \"type\": \"customer_property_set\",\n        \"customer_property_id\": \"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11\"\n      }\n    ]\n  }\n}"

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

{
  "segment_id": 2,
  "segment_type": "custom",
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "name_set"
      },
      {
        "type": "customer_property_set",
        "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
      }
    ]
  },
  "referenced_customer_properties_definitions_ids": [
    "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
  ],
  "last_updated_at": "2026-08-08T10:15:00Z",
  "agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
  "agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}

Required scopes: customers:rw

Show example: create a segment for leads active within the last 30 days

request

{
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "last_active_days_ago",
        "days": 30
      },
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      }
    ]
  }
}

response

{
  "segment_id": 3,
  "segment_type": "custom",
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "last_active_days_ago",
        "days": 30
      },
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      }
    ]
  },
  "last_updated_at": "2026-08-08T10:16:00Z",
  "agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
  "agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}

Authorizations

Authorization

string

header

required

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

application/json

The custom segment definition to create. The service assigns an ID starting at 2 and always assigns the custom type. The request cannot include segment_id or segment_type; supplying either field, including a built-in ID of 0 or 1, returns a validation error.

definition

object

required

A node in a segment definition tree: one of two operators (and, or) or one of five conditions (name_set, email_set, phone_number_set, customer_property_set, last_active_days_ago). Every node type rejects unknown fields, including fields that are valid on a different node type.

Show child attributes

Response

The created segment definition.

A segment definition.

segment_id

integer<int64>

required

The definition ID, unique within the organization. The built-in definitions use 0 (lead) and 1 (qualified lead). Custom definitions receive IDs starting at 2.

Example:

2

segment_type

enum<string>

required

The server-assigned segment type. It cannot be set or changed through the API.

lead — the built-in definition with ID 0.
qualified_lead — the built-in definition with ID 1.
custom — a definition created through create_segment_definition.

Available options:

lead,

qualified_lead,

custom

definition

object

required

Show child attributes

last_updated_at

string<date-time> | null

required

The date and time when the definition was most recently created or updated. This value records request-handling time, not commit order, and is not a concurrency token. Returns null for a built-in definition before its first update.

agent_account_id

string | null

required

The account ID of the agent who last created or updated the definition. Returns null for a built-in definition before its first update.

agent_client_id

string | null

required

The client ID of the app that last created or updated the definition. Returns null for a built-in definition before its first update.

referenced_customer_properties_definitions_ids

string<uuid>[]

Customer property definition IDs referenced in definition, deduplicated in definition order. Omitted when the tree has no customer_property_set node. The array includes IDs for properties archived or deleted after the segment definition was saved.

Overview

Customers

Customer properties

Segments

Create segment definition

Authorizations

Body

Response