Recompute membership

POST/v1/segments/{id}/refresh

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

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.

Path parameters

idstringrequired
Segment id.

Response

Membership delta.

enteredintegerrequired
exitedintegerrequired
memberCountintegerrequired

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
404Not found.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/segments/id_123/refresh \
  -X POST \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "entered": 1,
    "exited": 1,
    "memberCount": 1
  }
}

92 endpoints · OpenAPI document