Get Smart Campaign Flow Step Types

GET /rest/asset/v1/smartCampaign/flowStepTypes.json

Returns flow step types with constraint metadata. These are the subset valid for use as flow step choice conditions.

Operation ID: getSmartCampaignFlowStepTypesUsingGET
Permissions: Read-Only Assets, Read-Write Assets
Request format: application/x-www-form-urlencoded
Returns: ResponseOfSmartCampaignFlowStepType

Responses

200 OK ResponseOfSmartCampaignFlowStepType

errors array of Error

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

requestId string

result array of SmartCampaignFlowStepTypes

Model SmartCampaignFlowStepTypes

flowStepTypes array of SmartCampaignFlowStepType

Flow step types

Model SmartCampaignFlowStepType

id integer (int32) required

Id of the flow step type

name string required

Name of the flow step type

constraints array of RuleConstraint

Model RuleConstraint

result › flowStepTypes › constraints

id integer (int32)

Id of the constraint. Built-in constraints have negative ids

name string

Name of the constraint

dataType string

Data type of the constraint value

primary boolean

Whether this is the primary constraint of the rule type

operator string

Default operator of the constraint

dbAttrib boolean

Whether the constraint is a person or company field

dbAttribId string

Id of the person or company field

dbObject string

Object the field belongs to

type string

Field type of the constraint, for example standard or custom

success boolean

warnings array of string

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "flowStepTypes": [
        {
          "id": 123,
          "name": "Example name",
          "constraints": [
            {
              "id": null,
              "name": null,
              "dataType": null,
              "primary": null,
              "operator": null,
              "dbAttrib": null,
              "dbAttribId": null,
              "dbObject": null,
              "type": null
            }
          ]
        }
      ]
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.