OverviewPlatformsAPI Reference
Segments

Create a segment

Saves a people filter under a name. Names are unique in the workspace (409). The response says how many people match now.

POST
/v1/segments

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/segments" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": "string",  "name": "string",  "description": "string",  "filter": {    "platforms": [      "bluesky"    ],    "tags": [      "string"    ],    "minFollowers": 0,    "maxFollowers": 0,    "minMentions": 1,    "minNegative": 1,    "intents": [      "string"    ],    "keywordKinds": [      "brand"    ],    "neverKeywordKinds": [      "brand"    ],    "notPlatforms": [      "bluesky"    ],    "notTags": [      "string"    ],    "notIntents": [      "string"    ],    "newSinceDays": 1,    "linkHosts": [      "string"    ],    "muted": true,    "stages": [      "not_contacted"    ],    "automated": true,    "ownerIds": [      "string"    ]  },  "count": 0,  "createdAt": "string",  "updatedAt": "string"}
Was this page helpful?

Update a person

Changes your workspace's tags, notes and mute for the person, and the outreach owner and stage. The owner must be a workspace member, and null removes it. Muting hides their posts from your feed and all channels. Collection and billing do not change.

Delete a segment

Deletes the segment. The people in it are not changed.