List categories
List persisted category rows by status and categoryType. The blank/no-category value is idCategory="" on assets and is not returned as a category row.
query Parameters
statusStatus of resource
categoryTypeCanonical category type filter. Supported values are trafficsources, offersources, lander, offer, landerGroup, offerGroup, condition, visitorTag, logicscript, middlewareconfig, and webhookconfig.
List categories › Responses
List of categories
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusReserved 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 category by ID
Retrieve a category by its id
query Parameters
idCategoryID of the category to retrieve
Find category by ID › Responses
The requested category
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusReserved 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 categories by ID list
Retrieve all categories with the specified ids
query Parameters
idCategoriesList of category IDs to retrieve
Find categories by ID list › Responses
List of categories with the specified type and status
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusReserved 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 category
Update an existing category. The id cannot be changed.
Update a category › Request Body
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusReserved 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 category › Responses
Page category updated successfully
Create a category
Create a new category
Create a category › Request Body
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusReserved 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 category › Responses
Category created successfully
Duplicate a category
Create duplicate of existing category.
query Parameters
idCategoryID of the category to duplicate.
Duplicate a category › Request Body
nameName for the new asset
parentIdOptional parent/category ID for the new asset
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 category › Responses
The newly created category
idID of the newly created asset
Delete a category
Delete the specified categories. When cascade options are omitted, child assets keep existing behavior and move to Uncategorized (idCategory="") before the category is soft-deleted. cascade deletes supported child assets, move reassigns supported child assets to targetParentID with matching categoryType, orphan clears idCategory.
query Parameters
idCategoryLegacy single category ID fallback.
Delete a category › Request Body optional
entriesParent IDs to delete or archive. Delete endpoints also keep their legacy query-ID fallback.
cascadeActionOptional child handling action. Omit to preserve each endpoint's existing behavior.
targetParentIDRequired when cascadeAction is move. Rejected for other actions.
Delete a category › Responses
Categories deleted successfully
Archive categories
Archive the specified categories. Omitted cascade options preserve existing behavior and do not mutate child assets. cascade archives supported child assets, move reassigns supported child assets to targetParentID with matching categoryType, orphan clears idCategory.
Archive categories › Request Body
entriesParent IDs to delete or archive. Delete endpoints also keep their legacy query-ID fallback.
cascadeActionOptional child handling action. Omit to preserve each endpoint's existing behavior.
targetParentIDRequired when cascadeAction is move. Rejected for other actions.
Archive categories › Responses
Categories archived successfully