Update a contact segment

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

import requests

url = "http://localhost:8080/contacts/segments/{segment_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "definition": { "or": [{ "and": [{ "type": "all_contacts" }] }] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    definition: {or: [{and: [{type: 'all_contacts'}]}]}
  })
};

fetch('http://localhost:8080/contacts/segments/{segment_id}', 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/{segment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'definition' => [
        'or' => [
                [
                                'and' => [
                                                                [
                                                                                                                                'type' => 'all_contacts'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/{segment_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  }\n}")

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

require 'uri'
require 'net/http'

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

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

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

PATCH

contacts

segments

{segment_id}

Update a contact segment

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

import requests

url = "http://localhost:8080/contacts/segments/{segment_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "definition": { "or": [{ "and": [{ "type": "all_contacts" }] }] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    definition: {or: [{and: [{type: 'all_contacts'}]}]}
  })
};

fetch('http://localhost:8080/contacts/segments/{segment_id}', 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/{segment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'definition' => [
        'or' => [
                [
                                'and' => [
                                                                [
                                                                                                                                'type' => 'all_contacts'
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  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/{segment_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  }\n}")

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

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"definition\": {\n    \"or\": [\n      {\n        \"and\": [\n          {\n            \"type\": \"all_contacts\"\n          }\n        ]\n      }\n    ]\n  }\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 at least one of name, description, or definition. Omitted fields remain unchanged. A supplied definition replaces all filter rules; null matches all contacts. Filter changes recalculate membership in the background. 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.

Path Parameters

segment_id

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

name

string

description

string | null

definition

object | null

Show child attributes

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

Update a contact segment

Authorizations

Path Parameters

Body

Response