Logic Scripts

Download schema

API endpoints to manage logic script assets

List logic scripts

GET

https://api.funnelflux.pro/v1

/logicscript/list/

List all logic scripts. Logic scripts are global assets; use status and category filters for management views.

List logic scripts › query Parameters

status

string · enum · required

Status of resource

Enum values:

active

archived

not-deleted

all

idCategory

string

Optional category ID to filter by

List logic scripts › Responses

List of logic scripts

LogicScriptInfo[]

Slim logic script projection returned by list and findByStatus endpoints.

LogicScriptInfo

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display 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.

codeHash

string

Server-managed SHA-256 hash of code when returned by the backend.

Find logic script by ID

GET

https://api.funnelflux.pro/v1

/logicscript/find/byId/

Retrieve a logic script by its id.

Find logic script by ID › query Parameters

idLogicScript

string · required

The ID of the logic script to query.

Find logic script by ID › Responses

The requested logic script

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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.

Find logic scripts by ID list

GET

https://api.funnelflux.pro/v1

/logicscript/find/byIds/

Retrieve all logic scripts with the specified ids.

Find logic scripts by ID list › query Parameters

idLogicScripts

string · required

Comma-separated list of logic script IDs to retrieve.

Find logic scripts by ID list › Responses

The requested logic scripts

LogicScript[]

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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.

Find logic scripts by name

GET

https://api.funnelflux.pro/v1

/logicscript/find/byName/

Retrieve all logic scripts with the specified name.

Find logic scripts by name › query Parameters

logicScriptName

string · required

The logic script name to query.

Find logic scripts by name › Responses

The requested logic scripts

LogicScript[]

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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.

Find logic scripts by status

GET

https://api.funnelflux.pro/v1

/logicscript/find/byStatus/

Retrieve all logic scripts with the specified status. Returns slim projection (same as list endpoint). Use find/byId for full objects.

Find logic scripts by status › query Parameters

status

string · enum · required

Status of resource

Enum values:

active

archived

not-deleted

all

Find logic scripts by status › Responses

The requested logic scripts

LogicScriptInfo[]

Slim logic script projection returned by list and findByStatus endpoints.

LogicScriptInfo

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display 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.

codeHash

string

Server-managed SHA-256 hash of code when returned by the backend.

Find logic scripts by category

GET

https://api.funnelflux.pro/v1

/logicscript/find/byCategory/

Retrieve all logic scripts under the specified category.

Find logic scripts by category › query Parameters

idCategory

string · required

Parent category of resource

Find logic scripts by category › Responses

The requested logic scripts

LogicScript[]

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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 logic script

PUT

https://api.funnelflux.pro/v1

/logicscript/save/

Update an existing logic script. The id cannot be changed. codeHash and owner are server-managed and must be omitted on writes.

Update a logic script › Request Body

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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 logic script › Responses

Logic script updated successfully

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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.

PUT/logicscript/save/

curl --request PUT \
  --url https://api.funnelflux.pro/v1/logicscript/save \
  --header 'Content-Type: application/json' \
  --data '
{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}
'

Example Request Body

{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}

json

Example Responses

{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}

json

application/json

Create a logic script

POST

https://api.funnelflux.pro/v1

/logicscript/save/

Create a new logic script. logicScriptName and code are required. codeHash and owner are server-managed and must be omitted on writes. status defaults to active if omitted. Logic scripts are global assets and cannot be restricted to a funnel.

Create a logic script › Request Body

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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 logic script › Responses

Logic script created successfully

User-authored routing logic asset for logic funnel nodes.

LogicScript

idLogicScript

string · required

ID of the logic script.

logicScriptName

string · minLength: 1 · maxLength: 256 · required

Logic script display name. The backend trims and validates non-empty names.

code

string · minLength: 1 · maxLength: 10240 · required

Logic script code. Maximum size is 10 KB.

codeHash

string · readOnly

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

status

Status · enum

Lifecycle status. Defaults to active when omitted on write.

Enum values:

active

archived

deleted

Default: active

owner

string · readOnly

Server-managed owner. Omit on writes.

idCategory

string

Category ID. Empty if uncategorized.

Default:

description

string

Optional user-facing description.

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.

POST/logicscript/save/

curl --request POST \
  --url https://api.funnelflux.pro/v1/logicscript/save \
  --header 'Content-Type: application/json' \
  --data '
{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}
'

Example Request Body

{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}

json

Example Responses

{
  "idLogicScript": "logic-script-id",
  "logicScriptName": "Country Router",
  "status": "active",
  "idCategory": "",
  "code": "if country == \"US\" {\n  return \"us\"\n}\nreturn \"default\"",
  "codeHash": "64-character-sha256-hex",
  "description": "Routes US traffic to route key us and all other traffic to default",
  "meta": {}
}

json

application/json

Duplicate a logic script

POST

https://api.funnelflux.pro/v1

/logicscript/duplicate/

Create duplicate of an existing logic script. Only name plus optional bodyUpdates.idCategory, bodyUpdates.categoryName, and bodyUpdates.description are honored; script code and codeHash are copied from the source and server-managed.

Duplicate a logic script › query Parameters

idLogicScript

string · required

ID of the logic script to duplicate.

Duplicate a logic script › Request Body

LogicScriptDuplicateRequest

name

string · minLength: 1 · maxLength: 256 · required

Name for the new logic script.

object

Optional metadata overrides for the duplicated logic script. Only idCategory, categoryName, and description are honored; all other fields are ignored by the backend.

Duplicate a logic script › Responses

The newly created logic script

DuplicateResponse

id

string

ID of the newly created asset

Soft-delete logic scripts

DELETE

https://api.funnelflux.pro/v1

/logicscript/delete/

Mark the specified logic scripts as deleted. The row and script payload remain stored so existing funnel references and direct find-by-id/runtime paths can still resolve them. Accepts entries in the body and/or a single idLogicScript query fallback; IDs are deduplicated and body entries are preferred for bulk deletes.

Soft-delete logic scripts › query Parameters

idLogicScript

string

Optional single logic script ID to mark deleted. Body entries are preferred for bulk deletes; this query fallback is accepted for simple clients.

Soft-delete logic scripts › Request Body optional

StringList

entries

string[] · required

Soft-delete logic scripts › Responses

Logic scripts marked deleted successfully

No data returned

Get logic script language metadata

GET

https://api.funnelflux.pro/v1

/logicscripts/language

Return the backend-owned logic script language catalog used by builders and validation clients. This auth-api endpoint is not a Ledger gRPC RPC. LogicScript variables mirror public token formatting where possible; timezone is formatted like the public {timezone} token, for example GMT+7 or GMT-5, and utcOffsetHours is the matching whole-hour integer for time helpers. Time helpers use HHMM values plus utcOffsetHours; timeInRange supports overnight wraparound, so timeInRange(2200, 600, utcOffsetHours) means 22:00 through 06:00 in the visitor's local offset. Local non-recursive closures are allowed, for example isMobile := func() bool { return deviceType == "mobile" }.

Get logic script language metadata › Responses

Logic script language metadata

Validate logic script code

POST

https://api.funnelflux.pro/v1

/logicscripts/validate

Validate logic script source code and return static route keys plus dynamic-route status. This auth-api endpoint is not a Ledger gRPC RPC.

Validate logic script code › Request Body

code

string · maxLength: 10240 · required

Validate logic script code › Responses

Validation result

valid

boolean · required

routeKeys

string[]

dynamicRoutes

boolean

object[]

Archive logic scripts

PUT

https://api.funnelflux.pro/v1

/logicscript/archive/

Archive the specified logic scripts.

Archive logic scripts › Request Body

StringList

entries

string[] · required

Archive logic scripts › Responses

Logic scripts archived successfully

No data returned

Unarchive logic scripts

PUT

https://api.funnelflux.pro/v1

/logicscript/unarchive/

Unarchive the specified logic scripts.

Unarchive logic scripts › Request Body

StringList

entries

string[] · required

Unarchive logic scripts › Responses

Logic scripts unarchived successfully

No data returned

Move logic scripts to a category

PUT

https://api.funnelflux.pro/v1

/logicscript/move-category/

Move the specified logic scripts to a category. Use idCategory="" to remove assets from a category.

Move logic scripts 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 logic scripts to a category › Responses

Logic scripts moved successfully

No data returned

Conditions Visitor Tags