Skip to main content
POST
Create a contact segment

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string

Display name (1-200 chars).

description
string

Optional description (up to 1000 chars).

filters
object

AND/OR filter AST that defines the segment's membership.

rules
object

Legacy { operator, conditions } rule shape, still accepted for backwards compatibility.

auto_refresh
boolean

Whether the scheduler re-materialises membership automatically.

auto_refresh_interval_minutes
integer

Per-segment refresh cadence in minutes (1-1440).

Response

201 - application/json

The newly-created, already-materialised segment, wrapped in the standard { data, meta } envelope.

data
object
meta
object