Classify Segment Group
classify_segment_groupClassification costs credits (a flat per-person rate). The return carries the count of people the run will process and the credits it will charge (exact — the same population the run bills), so you can tell the user the cost; a run never charges more than the balance. If the balance can't cover the estimate the run is not enqueued — the return says so, and you should relay it. Dict with the in-scope person count and estimated credit cost, plus whether the run was enqueued or blocked for insufficient credits. Enqueued -> {"enqueued": true, "group_id", "person_count", "estimated_credits"}. Blocked -> {"enqueued": false, "reason": "insufficient_credits", "group_id", "person_count", "estimated_credits", "balance"}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Re-classify people already tagged for this group. | |
| group_id | Yes | The segment group to classify (from list_segment_groups). |