Flow
1 properties21 including nested8 operations use this
Properties
steps array of FlowStep
Model FlowStep
id integer (int32) required Id of the flow step, used in flow step mutation endpoints
activityTypeId integer (int32) required Id of the flow step action type
activityTypeName string required Name of the flow step action type
stepChoice array of FlowStepChoice
Model FlowStepChoice
id integer (int32) required Id of the choice, used in choice mutation endpoints
default boolean required Whether this is the default choice for the flow step
attributes array of FlowStepChoiceAttribute
Model FlowStepChoiceAttribute
steps › stepChoice › attributes
id integer (int32) required Id of the attribute
activityTypeAttribId integer (int32) Id of the activity type attribute definition
name string required Name of the attribute
dataType string Data type of the attribute value
value string Value of the attribute
format string Display format of the value
primary boolean Whether this is the primary attribute of the flow step
rule FlowStepChoiceRule
Condition for the choice, present on non-default choices
Model FlowStepChoiceRule
steps › stepChoice › rule
name string Name of the field tested by the condition
operator string Condition operator, for example 'is', 'is not', 'contains'
ruleType string Type of the condition
Values Activity Attribute
ruleTypeId integer (int32) Id of the activity type or field tested by the condition
values array of string Values the condition matches
Referenced models
Used by
Smart Campaigns
POSTAdd Flow StepPOSTAdd Step ChoiceGETGet Smart Campaign by IdGETGet Smart Campaign by NamePOSTRemove Flow StepPOSTRemove Flow Step ChoicePOSTReorder Flow Step ChoicePOSTUpdate Flow Step ChoiceGenerated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.