Create a segment

Display name.

Permanent identifier, lowercase-kebab-case, unique in your organization. Cannot be changed after creation.

How often the segment re-evaluates. Defaults to REACTIVE_ONLY — evaluate on demand with segments_evaluate.

For DAILY cadence: the hour (0-23, in your organization timezone) the segment evaluates.

When true, the segment is not evaluated on weekends.

When true, people Boom created for contacts who messaged you first (externalId boom:…) can match this segment. Defaults to false, or to true when the filter asks for them (identityOrigin MINTED). Boom enforces no marketing opt-in for them, so filter on consent yourself before marketing to them.

Stable internal identifier. Pass this wherever a segment reference is stored — e.g. a journey trigger's segmentId.

Unique identifier within your organization.

How often the segment is re-evaluated. REACTIVE_ONLY segments only change when evaluated explicitly.

Live count of currently active members.

Whether people Boom created for contacts who messaged you first can match. False by default.

ISO 8601 timestamp; null if the segment has never evaluated.

ISO 8601 timestamp.

Set when this update turned includeBoomCreated on: the people created by Boom who now match. They enter on the next evaluation; every journey this segment triggers starts for them, and every scheduled campaign that sends to it includes them.