Sign in
Segments

Create segment

Create a new audience segment.

DYNAMIC segments (the default) are defined by a condition — a boolean tree that is re-evaluated against your contacts, so membership changes on its own as contact data changes. condition is required for these.

STATIC segments hold a manually managed member list; condition is ignored. Add members with POST /segments/{id}/members.

post/segments

Request body

namestring required
descriptionstring
type'DYNAMIC' | 'STATIC'

Defaults to DYNAMIC when omitted.

trackMembershipboolean

Emit segment.<slug>.entry / segment.<slug>.exit events as contacts join and leave. These can be used as workflow triggers.

Response

Segment created

idstring
namestring
descriptionstring nullable
type'DYNAMIC' | 'STATIC'

DYNAMIC segments are evaluated from condition. STATIC segments hold a manually managed member list.

trackMembershipboolean

When true, contacts entering or leaving the segment emit segment.<slug>.entry / segment.<slug>.exit events.

memberCountinteger

Cached member count, refreshed by a background job rather than computed per request.

projectIdstring
createdAtstring date-time
updatedAtstring date-time

Changes