Segments API

Create dynamic contact segments for campaign targeting.

Endpoints

List Segments

GET /api/v1/contacts/segments

Create Segment

POST /api/v1/contacts/segments

{
  "name": "VIP Customers",
  "description": "High-value customers",
  "filters": {
    "rules": [
      { "field": "leadScore", "operator": "greaterThan", "value": 80 },
      { "field": "tags", "operator": "contains", "value": "vip" }
    ],
    "logic": "AND"
  },
  "isDynamic": true
}

Get Segment Contacts

GET /api/v1/contacts/segments/:id/contacts

Filter Operators

Operator	Description
equals	Equal to
notEquals	Not equal to
contains	Contains
greaterThan	Greater than
lessThan	Less than
between	Between two values
isEmpty	Is empty
isNotEmpty	Is not empty

Supported Fields

Field	Type
name	string
email	string
phone	string
tags	string
source	string
leadScore	number
lastMessageAt	date
createdAt	date