Flows (Streams)

Create flow

Creates flow

post/streams

Request

  • Base URL: https://admin-api.docs.keitaro.io/admin_api/v1
  • URL: https://admin-api.docs.keitaro.io/admin_api/v1/streams
  • Auth: API key in header Api-Key

Request body

campaign_idinteger required

Campaign ID

type'forced' | 'regular' | 'default' required

Flow type

namestring required

Flow name

positioninteger

Position of a flow among other flows.

weightnumber

Flow weight.

action_optionsobject

Action options.

commentsstring

Comments or notes for the flow

state'active' | 'disabled' | 'deleted'

State of the flow

action_typestring required

Action to perform (see 'Retrieve available flow action types')

schema'landings' | 'redirect' | 'action' required
collect_clicksboolean

Flow saves clicks (true/false)

filter_orboolean

Use 'OR' operator between filters

Response

Create a Flow

idinteger
typestring
namestring
campaign_idinteger
positioninteger
weightnumber
action_optionsobject
commentsstring
statestring
updated_atstring
action_typestring
schemastring
collect_clicksboolean
filter_orboolean
offer_selection'before_click' | 'after_click'

Changes

No recorded changes to this operation across all 1 revision of this API.