Update segment definition

curl --request POST \
  --url https://api.text.com/cdp/v1/update_segment_definition \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "segment_id": 0,
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "last_active_days_ago",
        "days": 14
      },
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      }
    ]
  }
}
'

import requests

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

payload = {
    "segment_id": 0,
    "definition": {
        "type": "and",
        "nodes": [
            {
                "type": "last_active_days_ago",
                "days": 14
            },
            {
                "type": "or",
                "nodes": [{ "type": "email_set" }, { "type": "phone_number_set" }]
            }
        ]
    }
}
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({
    segment_id: 0,
    definition: {
      type: 'and',
      nodes: [
        {type: 'last_active_days_ago', days: 14},
        {type: 'or', nodes: [{type: 'email_set'}, {type: 'phone_number_set'}]}
      ]
    }
  })
};

fetch('https://api.text.com/cdp/v1/update_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/update_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([
    'segment_id' => 0,
    'definition' => [
        'type' => 'and',
        'nodes' => [
                [
                                'type' => 'last_active_days_ago',
                                'days' => 14
                ],
                [
                                'type' => 'or',
                                'nodes' => [
                                                                [
                                                                                                                                'type' => 'email_set'
                                                                ],
                                                                [
                                                                                                                                'type' => 'phone_number_set'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/update_segment_definition"

	payload := strings.NewReader("{\n  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\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/update_segment_definition")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.text.com/cdp/v1/update_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  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\n      }\n    ]\n  }\n}"

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

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

POST

update_segment_definition

Update segment definition

curl --request POST \
  --url https://api.text.com/cdp/v1/update_segment_definition \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "segment_id": 0,
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "last_active_days_ago",
        "days": 14
      },
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      }
    ]
  }
}
'

import requests

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

payload = {
    "segment_id": 0,
    "definition": {
        "type": "and",
        "nodes": [
            {
                "type": "last_active_days_ago",
                "days": 14
            },
            {
                "type": "or",
                "nodes": [{ "type": "email_set" }, { "type": "phone_number_set" }]
            }
        ]
    }
}
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({
    segment_id: 0,
    definition: {
      type: 'and',
      nodes: [
        {type: 'last_active_days_ago', days: 14},
        {type: 'or', nodes: [{type: 'email_set'}, {type: 'phone_number_set'}]}
      ]
    }
  })
};

fetch('https://api.text.com/cdp/v1/update_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/update_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([
    'segment_id' => 0,
    'definition' => [
        'type' => 'and',
        'nodes' => [
                [
                                'type' => 'last_active_days_ago',
                                'days' => 14
                ],
                [
                                'type' => 'or',
                                'nodes' => [
                                                                [
                                                                                                                                'type' => 'email_set'
                                                                ],
                                                                [
                                                                                                                                'type' => 'phone_number_set'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/update_segment_definition"

	payload := strings.NewReader("{\n  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\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/update_segment_definition")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.text.com/cdp/v1/update_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  \"segment_id\": 0,\n  \"definition\": {\n    \"type\": \"and\",\n    \"nodes\": [\n      {\n        \"type\": \"last_active_days_ago\",\n        \"days\": 14\n      },\n      {\n        \"type\": \"or\",\n        \"nodes\": [\n          {\n            \"type\": \"email_set\"\n          },\n          {\n            \"type\": \"phone_number_set\"\n          }\n        ]\n      }\n    ]\n  }\n}"

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

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

Required scopes: customers:rw

Show example: customize the built-in qualified lead definition with a stricter tree

request

{
  "segment_id": 1,
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      },
      {
        "type": "name_set"
      },
      {
        "type": "customer_property_set",
        "customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
      }
    ]
  }
}

response

{
  "segment_id": 1,
  "segment_type": "qualified_lead",
  "definition": {
    "type": "and",
    "nodes": [
      {
        "type": "or",
        "nodes": [
          {
            "type": "email_set"
          },
          {
            "type": "phone_number_set"
          }
        ]
      },
      {
        "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:25:00Z",
  "agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
  "agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}

Show example: replace a custom definition's tree

request

{
  "segment_id": 2,
  "definition": {
    "type": "name_set"
  }
}

response

{
  "segment_id": 2,
  "segment_type": "custom",
  "definition": {
    "type": "name_set"
  },
  "last_updated_at": "2026-08-08T10:30: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 complete replacement for a segment definition. Partial tree updates are not supported. The request cannot include the server-assigned segment_type.

segment_id

integer<int64>

required

The definition ID to update. ID 0 identifies the lead definition, which every organization has unless it has been deleted. ID 1 identifies the qualified lead definition, which exists only after the organization creates it. The API returns 404 for a deleted definition or a qualified lead definition that has not been created. Use create_segment_definition to create the qualified lead definition or restore a deleted lead or qualified lead definition.

Example:

0

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 updated segment definition.

A segment definition.

segment_id

integer<int64>

required

The definition ID. ID 0 is reserved for the lead definition, which every organization has initially. ID 1 is reserved for the qualified lead definition, which exists only after the organization creates it. Custom definitions receive IDs starting at 2.

Example:

2

segment_type

enum<string>

required

The segment type is fixed for the lifetime of the definition:

lead — The definition with ID 0.
qualified_lead — The definition with ID 1.
custom — A definition with an ID starting at 2.

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. If multiple updates are processed at the same time, their timestamps may not match the order in which the updates are saved. The value is null for the lead definition before its first update.

agent_account_id

string | null

required

The account ID of the agent who last created or updated the definition. The value is null for the lead definition before its first update.

agent_client_id

string | null

required

The client ID of the app that last created or updated the definition. The value is null for the lead definition before its first update.

referenced_customer_properties_definitions_ids

string<uuid>[]

The 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 that were archived or deleted after the segment definition was saved.

Overview

Customers

Customer properties

Segments

Update segment definition

Authorizations

Body

Response