Create a segment
pushengage_create_segmentCreate a new push subscriber segment with optional URL include/exclude rules to filter members. Optionally evaluate criteria on every page visit so segment membership updates as subscribers browse.
Instructions
Creates a new segment on the current site. Required: segment_name. Optionally pass segment_criteria with URL include and/or exclude rules to define what subscribers belong to the segment — each rule is { rule: "start" | "exact" | "contains", value: "<url>" }. By default, segment criteria are evaluated only when a visitor subscribes to push notifications. Set add_segment_on_page_load=true (Segment on Page Visit) to evaluate those criteria on every page visit instead, so segment membership can change as subscribers browse the site. Only include segment_criteria and add_segment_on_page_load when the user explicitly describes the matching rules.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | No | Override the currently selected site. | |
| segment_name | Yes | Segment display name. 1–150 characters. | |
| segment_criteria | No | URL-based include/exclude rules that decide which subscribers belong to this segment. Omit to create a name-only segment that the user populates later via the dashboard or workflows. When provided, at least one of `include` or `exclude` must have rules. | |
| add_segment_on_page_load | No | Segment on Page Visit. By default (false), segment criteria (such as URL rules) are evaluated only when a visitor subscribes to push notifications. Set to true to evaluate those criteria on every page visit instead, so segment membership can change as subscribers browse your site. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view_url | No | ||
| segment_id | No | ||
| segment_name | No | ||
| segment_criteria | No | ||
| add_segment_on_page_load | No |