v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Segments

Update a segment

Update a segment in place; the slug is permanent. Changing the filter doesn't re-evaluate membership until the next evaluation.

patch/api/v1/segments/{slug}

slugstring required

The segment slug, as returned by segments_list.

namestring

Display name.

descriptionstring nullable

evaluationCadence'REACTIVE_ONLY' | 'HOURLY' | 'DAILY'

How often the segment re-evaluates.

dailyEvaluationHourinteger nullable

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

skipWeekendEvaluationboolean

When true, the segment is not evaluated on weekends.

Success

slugstring required

Unique identifier within your organization.

namestring required

descriptionstring nullable required

evaluationCadence'REACTIVE_ONLY' | 'HOURLY' | 'DAILY' required

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

memberCountinteger required

Live count of currently active members.

lastEvaluatedAtstring nullable required

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

createdAtstring required

ISO 8601 timestamp.