Skip to main content
PATCH
Update a segment

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

slug
string
required

The segment slug, as returned by segments_list.

Minimum string length: 1

Body

application/json
name
string

Display name.

Required string length: 1 - 120
description
string | null
Maximum string length: 1024
filterExpression
object

The audience filter: a tree of predicates over person attributes, related data, and events. Discover valid attr tokens and operators with segments_catalog (GET /api/v1/segments/catalog).

evaluationCadence
enum<string>

How often the segment re-evaluates.

Available options:
REACTIVE_ONLY,
HOURLY,
DAILY
dailyEvaluationHour
integer | null

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

Required range: 0 <= x <= 23
skipWeekendEvaluation
boolean

When true, the segment is not evaluated on weekends.

outputColumns
object

Optional extra columns to project for each member when the segment feeds downstream automations.

Response

Success

slug
string
required

Unique identifier within your organization.

name
string
required
description
string | null
required
evaluationCadence
enum<string>
required

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

Available options:
REACTIVE_ONLY,
HOURLY,
DAILY
memberCount
integer
required

Live count of currently active members.

Required range: -9007199254740991 <= x <= 9007199254740991
lastEvaluatedAt
string | null
required

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

createdAt
string
required

ISO 8601 timestamp.