Segments

Recompute membership

Recomputes a dynamic segment against the current contact graph and returns how many contacts entered, how many exited, and the resulting memberCount.

This has side effects beyond the count. Entering and exiting emit segment.entered and segment.exited, so any workflow triggered on those events is set off by this call and any webhook subscribed to them fires. Refreshing a large segment after a bulk import is therefore an automation event, not a read.

Static segments are not recomputed — their membership is whatever was added by hand — so for those the call only refreshes the stored count and reports entered: 0, exited: 0.

post/v1/segments/{id}/refresh

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/segments/{id}/refresh
  • Auth: HTTP bearer

Path parameters

idstring required

Segment id.

Response

Membership delta.

enteredinteger required
exitedinteger required
memberCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.