Create segment

POST

/segments

Creates a new segment (audience). Seeds a default view template and default workflow
(unless product-specific flags apply).

Typical product create payload:

name (required for useful audiences)

folderIds — optional folder membership

segmentSources — array of source ids to attach (e.g. LinkedIn social-listening sources)

workflowTasksModuleName / workflowTaskTemplatesToEnable — optional workflow seeding

description, conditions, config, columnInfo, pullContactsInterval — optional

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Created segment (JSON:API)

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

cURL

Create audience with LinkedIn social-listening sourcesCreate empty segment (attach sources later)

curl --location 'https://app.highperformr.ai/api/segments' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Acme inbound engagers",
    "folderIds": [],
    "segmentSources": [
        "src_li_inbound_01",
        "src_li_inbound_02"
    ]
}'

Response Example

200 - Success

{
    "data": {
        "id": "seg_4n2k8j",
        "type": "segments",
        "attributes": {
            "name": "Acme inbound engagers",
            "segmentSources": [
                "src_li_inbound_01",
                "src_li_inbound_02"
            ],
            "folderIds": [],
            "isDefault": false,
            "createdAt": "2025-04-08T09:01:44.000Z"
        }
    }
}

Modified at 2026-08-06 14:14:15

Type-ahead search for segments

Get segment by ID