Segments

Evaluate a segment now

Re-evaluate a segment's membership now instead of waiting for its cadence. Runs synchronously; can take a while for large organizations.

post/api/v1/segments/{slug}/evaluate

Path parameters

slugstring required

The segment slug, as returned by segments_list.

Response

Success

entrantsinteger required

People added to the segment by this evaluation.

leaversinteger required

People removed from the segment by this evaluation.

totalinteger required

Total active members after this evaluation.

Changes