Build Segment from Saved Integration Matches
build_saved_integration_segmentCreate a matched segment, or add unique saved identities to a compatible standalone matched segment. Call preview_saved_integration_segment first and confirm the exact counts and target with the user. Adding to an existing segment replaces its current version. Completion or failure may notify configured organization webhooks, subscriptions, and opted-in user email. This never reruns matching, charges again, or creates an Audience automatically. Requires 'creator' scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | Create a new matched segment or add identities to an existing one | |
| filters | No | Select saved matches by provider, connection, run, source kind, or time window | |
| request_id | No | Stable idempotency key; generated when omitted | |
| segment_name | No | Name for a new matched segment | |
| target_segment_id | No | Existing matched segment ID when mode is add_to_segment |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | ||
| status | Yes | ||
| preview | 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 | |
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| failure_code | Yes | ||
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| collection_id | Yes | ||
| 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. | |
| identity_count | Yes | ||
| failure_message | Yes | ||
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions | |
| target_segment_id | Yes | ||
| materialization_id | Yes |