Flows (Streams)

Update flow

Updates flow.

put/streams/{id}

Request

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

Path parameters

idinteger required

Flow ID

Request body

campaign_idinteger

Campaign ID

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

Flow type

namestring

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

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

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

Flow saves clicks (true/false)

filter_orboolean

Use 'OR' operator between filters

Response

Flow details

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.