Update Segment
patch_segmentRename a segment or replace a filter segment definition. Supply filters OR filter_groups, never both. record_limit=null removes a size limit; a positive limit requires bounded State, City, or ZIP Code geography. Definition changes create a new version; renaming does not. Use archive_segment to archive or restore. Requires the creator scope. Requires 'creator' scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New display name | |
| filters | No | Replacement AND-combined filters (filter subtype only) | |
| segment_id | Yes | Saved segment ID | |
| record_limit | No | Maximum population size (up to 1 billion); null removes the limit | |
| filter_groups | No | Replacement grouped filters (filter subtype only) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| guidance | No | Interpretation or recovery guidance for this result | |
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| segment_id | Yes | ||
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| money_display | No | Currency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |