Segments

Manage audience segments. Use action=“create” to create a new segment (requires name). Use action=“update” to update an existing segment (requires segment_id). Use action=“list” to get segments with filters.

Input Schema

Parameter	Type	Description
action	string	Action to perform on segments. Enum: create, list, update
segment_id	string	Segment UUID (required for update)
name	string	Segment name
description	string	Description
audience	string	Target audience category (e.g. professional, tech)
size	number	Estimated audience size
estimated_value	number	Estimated value
language	string	Language code (e.g. en)
is_active	boolean	Is segment active?
attributes	object	Additional attributes
site_id	string	Filter by site UUID
user_id	string	Filter by user UUID
limit	number	Max results
offset	number	Pagination offset

REST Endpoint

Actions map to sub-routes: create → /create, list → /get, update → /update.


POST /api/agents/tools/segments/create
POST /api/agents/tools/segments/get
POST /api/agents/tools/segments/update


POST /api/agents/tools/segments/create
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
 
{
  "site_id": "YOUR_SITE_ID",
  "name": "SaaS Decision Makers",
  "audience": "professional",
  "language": "en",
  "is_active": true
}

Response:


{
  "success": true,
  "segment": { "id": "...", "name": "SaaS Decision Makers" }
}