Conditions

API endpoints to manage conditions

List conditions

GET

https://api.funnelflux.pro/v1

/condition/list/

List all conditions. Use globalOnly=true to return only global conditions (not scoped to a specific funnel). idFunnel takes precedence over globalOnly when both are set.

List conditions › query Parameters

status

string · enum · required

Status of resource

Enum values:

active

archived

not-deleted

all

idFunnel

string

Filter to conditions scoped to this funnel. Takes precedence over globalOnly.

idCategory

string

Optional category ID to filter by

globalOnly

boolean

When true, return only global conditions (those not scoped to a specific funnel).

List conditions › Responses

List of conditions

FunnelConditionInfo[]

Slim condition projection returned by list and findByStatus endpoints.

FunnelConditionInfo

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

Condition's name.

status

Status · enum · required

Enum values:

active

archived

deleted

Default: active

idCategory

string

ID of the parent category

categoryName

string · maxLength: 256

Name of the parent category

Find condition by ID

GET

https://api.funnelflux.pro/v1

/condition/find/byId/

Retrieve a condition by its id

Find condition by ID › query Parameters

idCondition

string · required

The ID of the condition to query

Find condition by ID › Responses

The requested condition

FunnelCondition

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

FunnelConditionRoute[] · required

idCategory

string

Category ID. Empty if uncategorized

Default:

restrictToFunnelId

string

If empty, then can be used in all funnels, otherwise, id of the funnel that can use this condition. A funnel-scoped (local) condition is hidden from global condition lists and the UI but remains usable and fetchable by ID.

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

object

Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.

GET/condition/find/byId/

curl --request GET \
  --url 'https://api.funnelflux.pro/v1/condition/find/byId?idCondition=%3Cstring%3E'

Example Responses

{
  "idCondition": "idCondition",
  "conditionName": "Some Name",
  "idCategory": "idCategory",
  "restrictToFunnelId": "restrictToFunnelId",
  "status": "active",
  "routes": [
    {
      "operator": "or",
      "routeName": "Default Route",
      "groups": []
    },
    {
      "operator": "or",
      "routeName": "Route with Rules",
      "groups": [
        {
          "rules": [
            {
              "timeDayOfMonthParams": {
                "day": 3
              },
              "timeDayOfWeekParams": {
                "day": "sunday"
              },
              "trackingFieldParams": {
                "fieldName": "fieldName",
                "fieldValues": [
                  "fieldValues",
                  "fieldValues"
                ]
              },
              "test": "is",
              "genericParams": {
                "values": [
                  "values",
                  "values"
                ]
              },
              "timeOfDayParams": {
                "hour": 12,
                "minutes": 13
              },
              "timeDateParams": {
                "year": 1970,
                "month": 2,
                "day": 18
              },
              "timeMonthOfYearParams": {
                "month": 7
              },
              "attribute": "Location: Continent"
            }
          ],
          "operator": "or"
        }
      ]
    }
  ]
}

json

application/json

Find conditions by ID list

GET

https://api.funnelflux.pro/v1

/condition/find/byIds/

Retrieve all conditions with the specified ids

Find conditions by ID list › query Parameters

idConditions

string · required

List of the condition IDs to retrieve

Find conditions by ID list › Responses

The requested conditions

FunnelCondition[]

FunnelCondition

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

FunnelConditionRoute[] · required

idCategory

string

Category ID. Empty if uncategorized

Default:

restrictToFunnelId

string

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

object

Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.

GET/condition/find/byIds/

curl --request GET \
  --url 'https://api.funnelflux.pro/v1/condition/find/byIds?idConditions=%3Cstring%3E'

Example Responses

[
  {
    "idCondition": "idCondition",
    "conditionName": "Some Name",
    "idCategory": "idCategory",
    "restrictToFunnelId": "restrictToFunnelId",
    "status": "active",
    "routes": [
      {
        "operator": "or",
        "routeName": "Default Route",
        "groups": []
      },
      {
        "operator": "or",
        "routeName": "Route with Rules",
        "groups": [
          {
            "rules": [
              {
                "timeDayOfMonthParams": {
                  "day": 3
                },
                "timeDayOfWeekParams": {
                  "day": "sunday"
                },
                "trackingFieldParams": {
                  "fieldName": "fieldName",
                  "fieldValues": [
                    "fieldValues",
                    "fieldValues"
                  ]
                },
                "test": "is",
                "genericParams": {
                  "values": [
                    "values",
                    "values"
                  ]
                },
                "timeOfDayParams": {
                  "hour": 12,
                  "minutes": 13
                },
                "timeDateParams": {
                  "year": 1970,
                  "month": 2,
                  "day": 18
                },
                "timeMonthOfYearParams": {
                  "month": 7
                },
                "attribute": "Location: Continent"
              }
            ],
            "operator": "or"
          }
        ]
      }
    ]
  }
]

json

application/json

Find conditions by status

GET

https://api.funnelflux.pro/v1

/condition/find/byStatus/

Retrieve all conditions with the specified status, optionally filtering by parent funnel id. Returns slim projection (same as list endpoint). Use find/byId for full objects.

Find conditions by status › query Parameters

status

string · enum · required

Status of resource

Enum values:

active

archived

not-deleted

all

idFunnel

string

The optional parent funnel ID to filter the query to

Find conditions by status › Responses

The requested conditions

FunnelConditionInfo[]

Slim condition projection returned by list and findByStatus endpoints.

FunnelConditionInfo

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

Condition's name.

status

Status · enum · required

Enum values:

active

archived

deleted

Default: active

idCategory

string

ID of the parent category

categoryName

string · maxLength: 256

Name of the parent category

Find conditions by category

GET

https://api.funnelflux.pro/v1

/condition/find/byCategory/

Retrieve all conditions under the specified category, optionally filtering by parent funnel id

Find conditions by category › query Parameters

idCategory

string · required

Parent category of resource

idFunnel

string

The optional ID of the funnel to filter to

Find conditions by category › Responses

The requested conditions

FunnelCondition[]

FunnelCondition

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

FunnelConditionRoute[] · required

idCategory

string

Category ID. Empty if uncategorized

Default:

restrictToFunnelId

string

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

object

Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.

GET/condition/find/byCategory/

curl --request GET \
  --url 'https://api.funnelflux.pro/v1/condition/find/byCategory?idCategory=%3Cstring%3E'

Example Responses

[
  {
    "idCondition": "idCondition",
    "conditionName": "Some Name",
    "idCategory": "idCategory",
    "restrictToFunnelId": "restrictToFunnelId",
    "status": "active",
    "routes": [
      {
        "operator": "or",
        "routeName": "Default Route",
        "groups": []
      },
      {
        "operator": "or",
        "routeName": "Route with Rules",
        "groups": [
          {
            "rules": [
              {
                "timeDayOfMonthParams": {
                  "day": 3
                },
                "timeDayOfWeekParams": {
                  "day": "sunday"
                },
                "trackingFieldParams": {
                  "fieldName": "fieldName",
                  "fieldValues": [
                    "fieldValues",
                    "fieldValues"
                  ]
                },
                "test": "is",
                "genericParams": {
                  "values": [
                    "values",
                    "values"
                  ]
                },
                "timeOfDayParams": {
                  "hour": 12,
                  "minutes": 13
                },
                "timeDateParams": {
                  "year": 1970,
                  "month": 2,
                  "day": 18
                },
                "timeMonthOfYearParams": {
                  "month": 7
                },
                "attribute": "Location: Continent"
              }
            ],
            "operator": "or"
          }
        ]
      }
    ]
  }
]

json

application/json

Update a condition

PUT

https://api.funnelflux.pro/v1

/condition/save/

Update an existing condition. The id cannot be changed.

Update a condition › Request Body

FunnelCondition

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

FunnelConditionRoute[] · required

idCategory

string

Category ID. Empty if uncategorized

Default:

restrictToFunnelId

string

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

object

Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.

Update a condition › Responses

Condition updated successfully

No data returned

PUT/condition/save/

curl --request PUT \
  --url https://api.funnelflux.pro/v1/condition/save \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": "idCondition",
  "conditionName": "Some Name",
  "idCategory": "idCategory",
  "restrictToFunnelId": "restrictToFunnelId",
  "status": "active",
  "routes": [
    {
      "operator": "or",
      "routeName": "Default Route",
      "groups": []
    },
    {
      "operator": "or",
      "routeName": "Route with Rules",
      "groups": [
        {
          "rules": [
            {
              "timeDayOfMonthParams": {
                "day": 3
              },
              "timeDayOfWeekParams": {
                "day": "sunday"
              },
              "trackingFieldParams": {
                "fieldName": "fieldName",
                "fieldValues": [
                  "fieldValues",
                  "fieldValues"
                ]
              },
              "test": "is",
              "genericParams": {
                "values": [
                  "values",
                  "values"
                ]
              },
              "timeOfDayParams": {
                "hour": 12,
                "minutes": 13
              },
              "timeDateParams": {
                "year": 1970,
                "month": 2,
                "day": 18
              },
              "timeMonthOfYearParams": {
                "month": 7
              },
              "attribute": "Location: Continent"
            }
          ],
          "operator": "or"
        }
      ]
    }
  ]
}
'

Example Request Body

{
  "idCondition": "idCondition",
  "conditionName": "Some Name",
  "idCategory": "idCategory",
  "restrictToFunnelId": "restrictToFunnelId",
  "status": "active",
  "routes": [
    {
      "operator": "or",
      "routeName": "Default Route",
      "groups": []
    },
    {
      "operator": "or",
      "routeName": "Route with Rules",
      "groups": [
        {
          "rules": [
            {
              "timeDayOfMonthParams": {
                "day": 3
              },
              "timeDayOfWeekParams": {
                "day": "sunday"
              },
              "trackingFieldParams": {
                "fieldName": "fieldName",
                "fieldValues": [
                  "fieldValues",
                  "fieldValues"
                ]
              },
              "test": "is",
              "genericParams": {
                "values": [
                  "values",
                  "values"
                ]
              },
              "timeOfDayParams": {
                "hour": 12,
                "minutes": 13
              },
              "timeDateParams": {
                "year": 1970,
                "month": 2,
                "day": 18
              },
              "timeMonthOfYearParams": {
                "month": 7
              },
              "attribute": "Location: Continent"
            }
          ],
          "operator": "or"
        }
      ]
    }
  ]
}

json

Example Responses

No example specified for this content type

Create a condition

POST

https://api.funnelflux.pro/v1

/condition/save/

Create a new condition

Create a condition › Request Body

FunnelCondition

idCondition

string · required

ID of the condition

conditionName

string · minLength: 1 · maxLength: 256 · required

FunnelConditionRoute[] · required

idCategory

string

Category ID. Empty if uncategorized

Default:

restrictToFunnelId

string

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

object

Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.

Create a condition › Responses

Condition created successfully

No data returned

POST/condition/save/

curl --request POST \
  --url https://api.funnelflux.pro/v1/condition/save \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": "idCondition",
  "conditionName": "Some Name",
  "idCategory": "idCategory",
  "restrictToFunnelId": "restrictToFunnelId",
  "status": "active",
  "routes": [
    {
      "operator": "or",
      "routeName": "Default Route",
      "groups": []
    },
    {
      "operator": "or",
      "routeName": "Route with Rules",
      "groups": [
        {
          "rules": [
            {
              "timeDayOfMonthParams": {
                "day": 3
              },
              "timeDayOfWeekParams": {
                "day": "sunday"
              },
              "trackingFieldParams": {
                "fieldName": "fieldName",
                "fieldValues": [
                  "fieldValues",
                  "fieldValues"
                ]
              },
              "test": "is",
              "genericParams": {
                "values": [
                  "values",
                  "values"
                ]
              },
              "timeOfDayParams": {
                "hour": 12,
                "minutes": 13
              },
              "timeDateParams": {
                "year": 1970,
                "month": 2,
                "day": 18
              },
              "timeMonthOfYearParams": {
                "month": 7
              },
              "attribute": "Location: Continent"
            }
          ],
          "operator": "or"
        }
      ]
    }
  ]
}
'

Example Request Body

{
  "idCondition": "idCondition",
  "conditionName": "Some Name",
  "idCategory": "idCategory",
  "restrictToFunnelId": "restrictToFunnelId",
  "status": "active",
  "routes": [
    {
      "operator": "or",
      "routeName": "Default Route",
      "groups": []
    },
    {
      "operator": "or",
      "routeName": "Route with Rules",
      "groups": [
        {
          "rules": [
            {
              "timeDayOfMonthParams": {
                "day": 3
              },
              "timeDayOfWeekParams": {
                "day": "sunday"
              },
              "trackingFieldParams": {
                "fieldName": "fieldName",
                "fieldValues": [
                  "fieldValues",
                  "fieldValues"
                ]
              },
              "test": "is",
              "genericParams": {
                "values": [
                  "values",
                  "values"
                ]
              },
              "timeOfDayParams": {
                "hour": 12,
                "minutes": 13
              },
              "timeDateParams": {
                "year": 1970,
                "month": 2,
                "day": 18
              },
              "timeMonthOfYearParams": {
                "month": 7
              },
              "attribute": "Location: Continent"
            }
          ],
          "operator": "or"
        }
      ]
    }
  ]
}

json

Example Responses

No example specified for this content type

Duplicate a condition

POST

https://api.funnelflux.pro/v1

/condition/duplicate/

Create duplicate of existing condition.

Duplicate a condition › query Parameters

idCondition

string · required

ID of the condition to duplicate.

Duplicate a condition › Request Body

DuplicateRequest

name

string · minLength: 1 · maxLength: 256 · required

Name for the new asset

parentId

string

Optional parent/category ID for the new asset

object

Optional field overrides to merge into the duplicated asset. Keys are JSON field names (e.g. baseURL, trackingFieldSlots). Protected fields (ID, owner, status) cannot be changed via this field — they are always set by the server after the merge.

Duplicate a condition › Responses

The newly created condition

DuplicateResponse

id

string

ID of the newly created asset

Delete a condition

DELETE

https://api.funnelflux.pro/v1

/condition/delete/

Delete the specified conditions

Delete a condition › Request Body

StringList

entries

string[] · required

Delete a condition › Responses

Conditions deleted successfully

No data returned

Archive conditions

PUT

https://api.funnelflux.pro/v1

/condition/archive/

Archive the specified conditions

Archive conditions › Request Body

StringList

entries

string[] · required

Archive conditions › Responses

Conditions archived successfully

No data returned

Unarchive conditions

PUT

https://api.funnelflux.pro/v1

/condition/unarchive/

Unarchive the specified conditions

Unarchive conditions › Request Body

StringList

entries

string[] · required

Unarchive conditions › Responses

Conditions unarchived successfully

No data returned

Move conditions to a category

PUT

https://api.funnelflux.pro/v1

/condition/move-category/

Move the specified conditions to a category

Move conditions to a category › Request Body

MoveCategoryRequest

entries

string[] · required

List of asset IDs to move

idCategory

string · required

Target category ID (empty string to remove from category)

Move conditions to a category › Responses

Conditions moved successfully

No data returned

Funnels Logic Scripts