Update segment

PATCH

/segments/{id}

Partial update of a segment. Fields accepted by the controller:
name, description, conditions, segmentSources, folderIds,
pullContactsInterval, clonedFrom, columnInfo.

Set folderIds to one or more folder template ids to assign the segment;
send folderIds: [] to remove it from all folders.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Updated segment

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

cURL

Rename segmentAttach LinkedIn sourcesMove to a folderRemove from all folders

curl --location --request PATCH 'https://app.highperformr.ai/api/segments/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Enterprise prospects (Q2)"
}'

Response Example

200 - Success

{
    "data": {
        "id": "seg_4n2k8j",
        "type": "segments",
        "attributes": {
            "name": "Enterprise prospects (Q2)",
            "segmentSources": [
                "src_li_inbound_01"
            ]
        }
    }
}

Modified at 2026-09-24 07:44:15

Get segment by ID

Delete segment