Offer Sources

Download schema

API endpoints to manage offer sources

List offer sources

GET

https://api.funnelflux.pro/v1

/offersource/list/

List all offer sources

List offer sources › 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 offer sources › Responses

List of offer sources

OfferSourceInfo[]

Slim offer source projection returned by list and findByStatus endpoints.

OfferSourceInfo

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source'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 offer source by ID

GET

https://api.funnelflux.pro/v1

/offersource/find/byId/

Retrieve an offer source by ID

Find offer source by ID › query Parameters

idOfferSource

string · required

The ID of the offer source

Find offer source by ID › Responses

The requested offer source

OfferSource

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source's name.

object

Query parameters to add to the url. Tokens can be used as values.

umrDomainOverride

string

Optional same-owner bare domain to use for UMR offer bounces.

Default:

postbackSubId

string

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackTxId

string

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackPayout

string

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

idCategory

string

Category ID. Empty if uncategorized

Default:

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 offer sources by ID list

GET

https://api.funnelflux.pro/v1

/offersource/find/byIds/

Retrieve all offer sources with the specified ids

Find offer sources by ID list › query Parameters

idOfferSources

string · required

List of the offer source IDs to retrieve

Find offer sources by ID list › Responses

List of offer sources with the specified ids

OfferSource[]

OfferSource

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source's name.

object

Query parameters to add to the url. Tokens can be used as values.

umrDomainOverride

string

Optional same-owner bare domain to use for UMR offer bounces.

Default:

postbackSubId

string

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackTxId

string

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackPayout

string

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

idCategory

string

Category ID. Empty if uncategorized

Default:

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 offer sources by status

GET

https://api.funnelflux.pro/v1

/offersource/find/byStatus/

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

Find offer sources by status › query Parameters

status

string · enum · required

Status of resource

Enum values:

active

archived

not-deleted

all

Find offer sources by status › Responses

List of offer sources with the specified status

OfferSourceInfo[]

Slim offer source projection returned by list and findByStatus endpoints.

OfferSourceInfo

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source'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 offer sources by category

GET

https://api.funnelflux.pro/v1

/offersource/find/byCategory/

Retrieve all offer sources under the specified category

Find offer sources by category › query Parameters

idCategory

string · required

Parent category of resource

Find offer sources by category › Responses

List of offer sources

OfferSource[]

OfferSource

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source's name.

object

Query parameters to add to the url. Tokens can be used as values.

umrDomainOverride

string

Optional same-owner bare domain to use for UMR offer bounces.

Default:

postbackSubId

string

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackTxId

string

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackPayout

string

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

idCategory

string

Category ID. Empty if uncategorized

Default:

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.

Save offer source

PUT

https://api.funnelflux.pro/v1

/offersource/save/

Update an existing offer source. The id cannot be changed.

Save offer source › Request Body

OfferSource

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source's name.

object

Query parameters to add to the url. Tokens can be used as values.

umrDomainOverride

string

Optional same-owner bare domain to use for UMR offer bounces.

Default:

postbackSubId

string

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackTxId

string

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackPayout

string

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

idCategory

string

Category ID. Empty if uncategorized

Default:

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.

Save offer source › Responses

Offer source updated successfully

No data returned

Create offer source

POST

https://api.funnelflux.pro/v1

/offersource/save/

Create a new offer source

Create offer source › Request Body

OfferSource

idOfferSource

string · required

ID of the offer source

offerSourceName

string · minLength: 1 · maxLength: 256 · required

Offer source's name.

object

Query parameters to add to the url. Tokens can be used as values.

umrDomainOverride

string

Optional same-owner bare domain to use for UMR offer bounces.

Default:

postbackSubId

string

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackTxId

string

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

postbackPayout

string

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Default:

status

Status · enum

Enum values:

active

archived

deleted

Default: active

idCategory

string

Category ID. Empty if uncategorized

Default:

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 offer source › Responses

Offer source created successfully

No data returned

POST/offersource/save/

curl --request POST \
  --url https://api.funnelflux.pro/v1/offersource/save \
  --header 'Content-Type: application/json' \
  --data '
{
  "idOfferSource": "1",
  "offerSourceName": "offerSourceName",
  "postbackSubId": "subid",
  "postbackTxId": "txid",
  "postbackPayout": "payout",
  "queryParams": {
    "param1": "value1",
    "param2": "value2"
  },
  "umrDomainOverride": "clean.example.com"
}
'

Example Request Body

{
  "idOfferSource": "1",
  "offerSourceName": "offerSourceName",
  "postbackSubId": "subid",
  "postbackTxId": "txid",
  "postbackPayout": "payout",
  "queryParams": {
    "param1": "value1",
    "param2": "value2"
  },
  "umrDomainOverride": "clean.example.com"
}

json

Example Responses

No example specified for this content type

Duplicate offer source

POST

https://api.funnelflux.pro/v1

/offersource/duplicate/

Create duplicate of existing offer source.

Duplicate offer source › query Parameters

idOfferSource

string · required

ID of the offer source to duplicate.

Duplicate offer source › 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 offer source › Responses

The newly created offer source

DuplicateResponse

id

string

ID of the newly created asset

Delete offer source

DELETE

https://api.funnelflux.pro/v1

/offersource/delete/

Delete the specified offer sources. Omitted cascade options preserve existing behavior and do not mutate child offer pages. cascade deletes child offer pages, move reassigns child offer pages to targetParentID, orphan clears offerParams.idOfferSource.

Delete offer source › query Parameters

idOfferSource

string

Legacy single offer source ID fallback.

Delete offer source › Request Body optional

ParentMutationRequest

entries

string[] · minItems: 1 · required

Parent IDs to delete or archive. Delete endpoints also keep their legacy query-ID fallback.

cascadeAction

string · enum

Optional child handling action. Omit to preserve each endpoint's existing behavior.

Enum values:

cascade

move

orphan

targetParentID

string

Required when cascadeAction is move. Rejected for other actions.

Delete offer source › Responses

Offer sources deleted successfully

No data returned

Archive offer sources

PUT

https://api.funnelflux.pro/v1

/offersource/archive/

Archive the specified offer sources. Omitted cascade options preserve existing behavior and do not mutate child offer pages. cascade archives child offer pages, move reassigns child offer pages to targetParentID, orphan clears offerParams.idOfferSource.

Archive offer sources › Request Body

ParentMutationRequest

entries

string[] · minItems: 1 · required

Parent IDs to delete or archive. Delete endpoints also keep their legacy query-ID fallback.

cascadeAction

string · enum

Optional child handling action. Omit to preserve each endpoint's existing behavior.

Enum values:

cascade

move

orphan

targetParentID

string

Required when cascadeAction is move. Rejected for other actions.

Archive offer sources › Responses

Offer sources archived successfully

No data returned

Unarchive offer sources

PUT

https://api.funnelflux.pro/v1

/offersource/unarchive/

Unarchive the specified offer sources

Unarchive offer sources › Request Body

StringList

entries

string[] · required

Unarchive offer sources › Responses

Offer sources unarchived successfully

No data returned

Move offer sources to a category

PUT

https://api.funnelflux.pro/v1

/offersource/move-category/

Move the specified offer sources to a category

Move offer sources 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 offer sources to a category › Responses

Offer sources moved successfully

No data returned

Traffic Sources Funnel Groups