Skip to content
Tallyraydocs

Take a path out of rotation wherever it is, a flow's rule's, a flow's default or a campaign's own, changing nothing else; its visits go where the flow then says. One paused already, or whose flow or campaign changed since expected_sequence, is left as it stands (changed false)

POST
/v1/buyer/paths/{id}/pause
curl --request POST \
  --url https://example.com/v1/buyer/paths/example/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_sequence": 1 }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expected_sequence
integer format: int64

Example generated

{
  "expected_sequence": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
campaign
required
Any of:
object
bot_action
required
string | null
Allowed values: flag block
connection
required
object
id
required
integer format: int64
name
string
cost_amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cost_bps
required
integer format: int32
cost_model
required
string | null
Allowed values: from_token cpc cpm cpa revshare api none
count_impressions
required
boolean
count_impressions_since
required
string | null format: date-time
created_at
required
string format: date-time
flow
required
Any of:
object
id
required
integer format: int64
name
string
id
required
integer format: int64
name
required
string
path
required
Any of:
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
redirect_mode
required
string | null
Allowed values: http meta double_meta
sequence
required
integer format: int64
status
required
string | null
Allowed values: active paused archived
tags
required
Array<string>
updated_at
required
string format: date-time
url
required
string | null
url_key
required
string
workspace_id
required
integer format: int64
changed
required
boolean
flow
required
Any of:
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 

{
  "campaign": {
    "bot_action": "flag",
    "cost_model": "from_token",
    "path": {
      "redirect_mode": "http"
    },
    "redirect_mode": "http",
    "status": "active"
  },
  "flow": {
    "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"
  }
}