Create Conditional Split Step

Add a new conditional split step to a funnel. All fields are optional — providing none creates an empty unconfigured split. Provide condition to set the contact filter, branches to attach pages to one or both branches, and/or show_page_step_id to position the split in the workflow.

See the Funnels Skill for the full surface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

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.

condition

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.

Branches

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.

Positioning

See show_page_step_id semantics — identical to the split test step endpoint.

conditional_split_step
object
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json