FlowPath Object
Represents a possible path that contacts can take from a split node. Each path defines conditions or criteria that determine which contacts follow it, and where they go next in the journey.
Fields
#
engaged
For FlowEngagementSplit nodes: if true, this path is for contacts who engaged with previous emails in the journey (opened/clicked). If false, for contacts who did not engage.
filter
For FlowDecisionSplit nodes: the filter conditions that contacts must meet to take this path. Contacts are evaluated against each path's filter in order.
isDefault
For FlowDecisionSplit nodes: indicates if this is the default/catch-all path. Contacts who don't match any other path's filters will take the default path. Only one path can be default.
isDeleted
Indicates if this path has been soft-deleted. Deleted paths are not evaluated during journey execution.
name
The display name of the path shown in the journey builder. Helps identify the path's purpose (e.g., 'High Value Customers', 'Engaged Users', '25% Sample').
nextNodeId
The ID of the node that contacts will flow to when they take this path. Null if this path ends the journey branch.
percentage
For FlowRandomSplit nodes: the percentage (0-100) of contacts that should be randomly assigned to this path. The sum of all path percentages should equal 100.
Usages
#
References
#
- Field createJourneyFlowPath from Mutation
- Field updateJourneyFlowPath from Mutation
- Field paths from FlowDecisionSplit
FlowJoin
FlowPathFilterInput