Update Segment

Update segment

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/segment/update \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "segment_id": 123,
  "segment_name": "<string>",
  "description": "<string>",
  "audience_id": 123,
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/segment/update"

payload = {
    "segment_id": 123,
    "segment_name": "<string>",
    "description": "<string>",
    "audience_id": 123,
    "conditions": [
        {
            "field": "<string>",
            "value": "<string>"
        }
    ],
    "tags": ["<string>"]
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    segment_id: 123,
    segment_name: '<string>',
    description: '<string>',
    audience_id: 123,
    conditions: [{field: '<string>', value: '<string>'}],
    tags: ['<string>']
  })
};

fetch('https://dev.tryunleashx.com/api/v1/global/segment/update', 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://dev.tryunleashx.com/api/v1/global/segment/update",
  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' => 123,
    'segment_name' => '<string>',
    'description' => '<string>',
    'audience_id' => 123,
    'conditions' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ],
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$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://dev.tryunleashx.com/api/v1/global/segment/update"

	payload := strings.NewReader("{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<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://dev.tryunleashx.com/api/v1/global/segment/update")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/segment/update")

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

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "<string>",
  "data": {
    "id": 123,
    "total_contacts": 123
  }
}

POST

segment

update

Update segment

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/segment/update \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "segment_id": 123,
  "segment_name": "<string>",
  "description": "<string>",
  "audience_id": 123,
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/segment/update"

payload = {
    "segment_id": 123,
    "segment_name": "<string>",
    "description": "<string>",
    "audience_id": 123,
    "conditions": [
        {
            "field": "<string>",
            "value": "<string>"
        }
    ],
    "tags": ["<string>"]
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    segment_id: 123,
    segment_name: '<string>',
    description: '<string>',
    audience_id: 123,
    conditions: [{field: '<string>', value: '<string>'}],
    tags: ['<string>']
  })
};

fetch('https://dev.tryunleashx.com/api/v1/global/segment/update', 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://dev.tryunleashx.com/api/v1/global/segment/update",
  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' => 123,
    'segment_name' => '<string>',
    'description' => '<string>',
    'audience_id' => 123,
    'conditions' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ],
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$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://dev.tryunleashx.com/api/v1/global/segment/update"

	payload := strings.NewReader("{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<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://dev.tryunleashx.com/api/v1/global/segment/update")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/segment/update")

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

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"segment_id\": 123,\n  \"segment_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "<string>",
  "data": {
    "id": 123,
    "total_contacts": 123
  }
}

Use this endpoint to update a segment’s name, description, audience, filters, tags, or status. Passing status: 2 soft-deletes the segment.

Endpoint

POST /segment/update Content-Type: application/json Authentication: Required (workspace auth)

Request Body

Update fields

{
  "segment_id": 501,
  "segment_name": "Mumbai Premium (VIP)",
  "description": "Updated description",
  "audience_id": 12,
  "match_type": "any",
  "conditions": [
    { "field": "plan", "operator": "is", "value": "premium" },
    { "field": "plan", "operator": "is", "value": "vip" }
  ],
  "tags": ["premium", "vip"]
}

Soft-delete

{
  "segment_id": 501,
  "status": 2
}

Field	Type	Required	Description
`segment_id`	number	Yes	Segment identifier
`segment_name`	string	No	New name. Must be unique within the workspace (among non-deleted segments, excluding this one).
`description`	string	No	New description
`audience_id`	number	No	Re-scope the segment to a different audience. Must belong to the caller’s company/workspace.
`conditions` (alias `filter_conditions`)	array	No	New filter, flat format `[{ field, operator, value }]` — see Preview Segment for the operator list.
`match_type`	string	No	`all` or `any`. Only takes effect together with (or after) `conditions`/`filter_conditions`.
`tags`	array	No	Replaces the segment’s tags. Accepts a real array, a JSON-stringified array, or a comma-separated string.
`status`	number	No	`0` = Inactive, `1` = Active, `2` = Deleted (soft-delete). Any other value is ignored.

Response

{
  "message": "Segment updated successfully",
  "data": { "id": 501, "total_contacts": 140 }
}

When status: 2 is passed:

{
  "message": "Segment deleted successfully",
  "data": { "id": 501, "total_contacts": 128 }
}

Behavior

segment_id must be an existing, non-deleted segment owned by the caller’s company/workspace — you cannot use this endpoint to “undelete” a segment.
Renaming checks name-uniqueness against other non-deleted segments in the workspace (skipped while soft-deleting).
Changing audience_id re-validates ownership of the new audience via the same check used by Create Segment and Preview Segment.
Sending conditions/filter_conditions or match_type re-parses and stores the filter in the flat { match_type, conditions: [...] } shape — this replaces (and is a different shape from) the CONDITIONLIST tree that Create Segment writes.
When the audience or filter actually changed (and the request isn’t a delete), total_contacts is recomputed by evaluating the new filter against the (possibly new) audience’s contacts in memory.

Recomputing total_contacts here only updates the cached count — it does not re-materialize the segment’s underlying contact mapping. List Segment Contacts, Export Segment Contacts, and any campaign already attached to this segment keep dialing/reading the contact set that was materialized at Create Segment time, until the segment is deleted and a new one is created in its place.

Error Cases

Error	Cause
`Segment Id is required`	`segment_id` missing
`Segment not found`	`segment_id` doesn’t belong to the caller’s company/workspace, or is already deleted
`Segment name already exists in this workspace`	`segment_name` collides with another non-deleted segment
`Audience not found`	`audience_id` doesn’t belong to the caller’s company/workspace, or is deleted

Example cURL

curl -X POST https://www.tryunleashx.com/api/v1/global/segment/update \
  -H "Content-Type: application/json" \
  -H "token: <api_key>" \
  -d '{
    "segment_id": 501,
    "status": 2
  }'

Headers

token

string

required

API token for authentication

Body

application/json

segment_id

integer

required

Segment identifier

segment_name

string

New name. Must be unique within the workspace (among non-deleted segments, excluding this one).

description

string

audience_id

integer

Re-scope the segment to a different audience.

conditions

object[]

New filter, flat format. Alias: filter_conditions.

Show child attributes

match_type

enum<string>

Available options:

all,

any

Response

Segment updated (or deleted) successfully

message

string

data

object

Show child attributes

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Audience

Segment

Input Variables

Workspaces

Users

Endpoint

Request Body

Update fields

Soft-delete

Response

Behavior

Error Cases

Example cURL

Headers

Body

Response

​Endpoint

​Request Body

​Update fields

​Soft-delete

​Response

​Behavior

​Error Cases

​Example cURL

Headers

Body

Response

Endpoint

Request Body

Update fields

Soft-delete

Response

Behavior

Error Cases

Example cURL