List funnel groups
List all campaigns (DEPRECATED - use /funnelgroup/list/ instead)
query Parameters
statusStatus of resource
List funnel groups › Responses
List of campaigns
idCampaignID of the campaign
campaignNameCampaign's name.
statusFind funnel group by ID
Retrieve a campaign by its id (DEPRECATED - use /funnelgroup/find/byId/ instead)
query Parameters
idCampaignThe ID of the funnel group to retrieve
Find funnel group by ID › Responses
The requested campaign
idCampaignID of the campaign
campaignNameCampaign's name.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel groups by ID list
Retrieve all campaigns with the specified ids
query Parameters
idCampaignsList of the funnel group IDs to retrieve
Find funnel groups by ID list › Responses
List of campaigns with the specified status
idCampaignID of the campaign
campaignNameCampaign's name.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel groups by status
Retrieve all funnel groups (campaigns) with the specified status. Returns slim projection (same as list endpoint). Use find/byId for full objects.
query Parameters
statusStatus of resource
Find funnel groups by status › Responses
List of funnel groups with the specified status
idCampaignID of the campaign
campaignNameCampaign's name.
statusUpdate a funnel group
Update an existing campaign. The id cannot be changed.
Update a funnel group › Request Body
idCampaignID of the campaign
campaignNameCampaign's name.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel group › Responses
Campaign updated successfully
Create a funnel group
Create a new campaign
Create a funnel group › Request Body
idCampaignID of the campaign
campaignNameCampaign's name.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel group › Responses
Campaign created successfully
Duplicate a funnel group
Create duplicate of existing campaign.
query Parameters
idCampaignID of the campaign to duplicate.
Duplicate a funnel group › 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 funnel group › Responses
The newly created campaign
idID of the newly created asset
Delete a funnel group
Delete the specified campaigns/funnel groups. Omitted cascade options preserve existing behavior and do not mutate child funnels. cascade deletes child funnels, move reassigns child funnels to targetParentID, orphan is rejected because funnels require idFunnelGroup.
Delete a funnel group › 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.
Delete a funnel group › Responses
Campaigns deleted successfully
Archive funnel groups
Archive the specified campaigns/funnel groups. Omitted cascade options preserve existing behavior and do not mutate child funnels. cascade archives child funnels, move reassigns child funnels to targetParentID, orphan is rejected because funnels require idFunnelGroup.
Archive funnel groups › 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 funnel groups › Responses
Campaigns archived successfully
List funnel groups
List all funnel groups (campaigns) - V2 endpoint
query Parameters
statusStatus of resource
List funnel groups › Responses
List of funnel groups
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
statusFind funnel group by ID
Retrieve a funnel group by its id - V2 endpoint
query Parameters
idFunnelGroupThe ID of the funnel group to retrieve
Find funnel group by ID › Responses
The requested funnel group
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel groups by ID list
Retrieve all funnel groups with the specified ids - V2 endpoint
query Parameters
idFunnelGroupsList of the funnel group IDs to retrieve
Find funnel groups by ID list › Responses
List of funnel groups with the specified status
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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 funnel groups by status
Retrieve all funnel groups with the specified status. Returns slim projection (same as list endpoint). Use find/byId for full objects. Note: Response uses CampaignInfo field names (idCampaign, campaignName) for backward compatibility.
query Parameters
statusStatus of resource
Find funnel groups by status › Responses
List of funnel groups with the specified status
idCampaignID of the campaign
campaignNameCampaign's name.
statusUpdate an existing funnel group
Update an existing funnel group - V2 endpoint
Update an existing funnel group › Request Body
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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 an existing funnel group › Responses
Funnel group updated successfully
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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 new funnel group
Create a new funnel group - V2 endpoint
Create a new funnel group › Request Body
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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 new funnel group › Responses
Funnel group created successfully
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusReserved 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.
Duplicate a funnel group
Duplicate an existing funnel group.
query Parameters
idFunnelGroupID of the funnel group to duplicate.
Duplicate a funnel group › 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 funnel group › Responses
Funnel group duplicated successfully
idID of the newly created asset
Delete a funnel group
Delete a funnel group - V2 endpoint. Omitted cascade options preserve existing behavior and do not mutate child funnels. cascade deletes child funnels, move reassigns child funnels to targetParentID, orphan is rejected because funnels require idFunnelGroup.
query Parameters
idFunnelGroupLegacy single funnel group ID fallback.
Delete a funnel group › 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 funnel group › Responses
Funnel group deleted successfully
Archive funnel groups
Archive the specified funnel groups. Omitted cascade options preserve existing behavior and do not mutate child funnels. cascade archives child funnels, move reassigns child funnels to targetParentID, orphan is rejected because funnels require idFunnelGroup.
Archive funnel groups › 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 funnel groups › Responses
Funnel groups archived successfully