Skip to content
Tallyraydocs

Make a flow: its rules in order, their paths, and its default paths

POST
/v1/buyer/flows
curl --request POST \
  --url https://example.com/v1/buyer/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "default_paths": [ { "id": 1, "landers": [ { "id": 1, "weight": 1 } ], "name": "example", "offers": [ { "id": 1, "weight": 1 } ], "paused": true, "redirect_mode": "http", "steps": [ { "landers": [ { "id": 1, "weight": 1 } ], "name": "example" } ], "weight": 1 } ], "name": "example", "rules": [ { "conditions": [ { "dimension": "country", "operator": "in", "param": "example", "time_zone": "example", "values": [ "example" ], "window_seconds": 1 } ], "id": 1, "name": "example", "paths": [ { "id": 1, "landers": [ { "id": 1, "weight": 1 } ], "name": "example", "offers": [ { "id": 1, "weight": 1 } ], "paused": true, "redirect_mode": "http", "steps": [ { "landers": [ { "id": 1, "weight": 1 } ], "name": "example" } ], "weight": 1 } ], "paused": true } ], "sequence": 1, "status": "active", "sticky": true }'

Who: a workspace’s buyer, or its key. API keys with the buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
<= 64 characters

Made once per action and sent again on every retry of it, so the service acts once: the request_id of the create or money-moving call; a new one when left out

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
default_paths
required
Array<object>
object
id
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
string
Allowed values: http meta double_meta
steps
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
name
required
string
rules
required
Array<object>
object
conditions
required
Array<object>
object
dimension
required
string
Allowed values: country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain ip weekday hour token visitor_type
operator
required
string
Allowed values: in not_in contains not_contains at_least below
param
string
time_zone
string
values
required
Array<string>
window_seconds
integer | null format: int64
id
integer format: int64
name
required
string
paths
required
Array<object>
object
id
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
string
Allowed values: http meta double_meta
steps
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
paused
required
boolean
sequence
integer format: int64
status
string
Allowed values: active archived
sticky
required
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
created_at
required
string format: date-time
default_paths
required
Array<object>
object
id
required
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
required
string | null
Allowed values: http meta double_meta
steps
required
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
id
required
integer format: int64
name
required
string
rules
required
Array<object>
object
conditions
required
Array<object>
object
dimension
required
string | null
Allowed values: country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain ip weekday hour token visitor_type
operator
required
string | null
Allowed values: in not_in contains not_contains at_least below
param
required
string
time_zone
required
string
values
required
Array<string>
window_seconds
required
integer | null format: int64
id
required
integer format: int64
name
required
string
paths
required
Array<object>
object
id
required
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
required
string | null
Allowed values: http meta double_meta
steps
required
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
paused
required
boolean
sequence
required
integer format: int64
status
required
string | null
Allowed values: active archived
sticky
required
boolean
updated_at
required
string format: date-time
workspace_id
required
integer format: int64

Example 

{
  "default_paths": [
    {
      "redirect_mode": "http"
    }
  ],
  "rules": [
    {
      "conditions": [
        {
          "dimension": "country",
          "operator": "in"
        }
      ],
      "paths": [
        {
          "redirect_mode": "http"
        }
      ]
    }
  ],
  "status": "active"
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}