BETA — Conditional Split Steps are currently in beta. You can request access via the Funnel Coders community but keep in mind that BETA endpoints are subject to change.
Parameters for adding a new conditional split step to a funnel's workflow. The split
always starts as a 2-branch tree (matched first, unmatched second). All fields
below are optional — providing none creates an empty unconfigured split that
the caller can fill in later via PATCH.
Supply filter_id — the public id of a RefineFilter scoped to the same workspace.
Create filters first via POST /api/v2/workspaces/{workspace_id}/refine_filters.
Raw numeric ids are rejected for cross-tenant safety. See Attaching a filter
and Applying filters to conditional split steps.
Optional branches array — up to 2 entries; branches[0] is the matched branch,
branches[1] is the unmatched branch. Each entry may carry either:
page_id — a single fresh user_page id to attach as the branch's first step.
page_ids — an array of fresh user_page ids to attach in order. Use this to
build a branch with multiple sequential pages (e.g. matched users see Welcome →
Onboarding → CTA, while unmatched users see Email Capture → Welcome).
page_id and page_ids are mutually exclusive per branch entry. Each page
referenced must be in the same workspace and not already wired to any
ShowPageStep anywhere.
See show_page_step_id semantics — identical to the split test step endpoint.