Skip to content
Tallyraydocs

Undo an action as yourself: unblock the placement, resume the path or the campaign, resume the source object, or write back the bid or budget a rule changed, once its source takes it. No rule acts on it again until a person does

POST
/v1/buyer/automation/actions/{id}/undo
curl --request POST \
  --url https://example.com/v1/buyer/automation/actions/example/undo \
  --header 'Authorization: Bearer <token>'

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

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
block_state
required
string | null
Allowed values: blocking blocked unblocking unblocked failed listed
change_id
required
string
created_at
required
string format: date-time
engagement
required
Any of:
object
automation_score
required
integer | null format: int32
average_first_interaction_ms
required
integer format: int64
average_visible_ms
required
integer format: int64
blind_click_share_ppm
required
integer format: int64
blind_clicks
required
integer format: int64
first_interaction_ms
required
integer format: int64
interacted_views
required
integer format: int64
interaction_share_ppm
required
integer format: int64
lander_visits
required
integer format: int64
reporting_visits
required
integer format: int64
script_share_ppm
required
integer format: int64
signal_clicks
required
integer format: int64
views
required
integer format: int64
visible_ms
required
integer format: int64
webdriver_share_ppm
required
integer format: int64
webdriver_views
required
integer format: int64
error_code
required
string
error_message
required
string
evidence
required
Any of:
object
chance_ppm
required
integer format: int64
conversions
required
integer format: int64
draws
required
integer format: int32
from
required
string format: date-time
high
required
integer format: int64
low
required
integer format: int64
mean
required
integer format: int64
observed
required
integer format: int64
ratio_ppm
required
integer format: int64
revenue
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
seed
required
string
spend
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
to
required
string format: date-time
id
required
string
kind
required
string | null
Allowed values: block_placement pause_path pause_campaign warn pause_source_campaign pause_source_ad_group pause_source_ad set_bid set_budget
ratio_ppm
required
integer format: int64
rule
required
object
id
required
integer format: int64
name
string
run_id
required
string
sequence
required
integer format: int64
source_spend
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
source_state
required
string | null
Allowed values: active paused removed other not_found
stats
required
object
bot_impressions
required
integer format: int64
bot_share_ppm
required
integer format: int64
bots
required
integer format: int64
by_model
required
Array<object>
object
conversions_micros
required
integer format: int64
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
changes
required
Array<object>
object
absolute
required
integer format: int64
absolute_micros
required
integer | null format: int64
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
relative_ppm
required
integer | null format: int64
clicks
required
integer format: int64
comparison
required
Any of:
object recursive
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
cost
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpm
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cpv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
cr_ppm
required
integer format: int64
ctr_ppm
required
integer format: int64
epc
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epv
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
event_types
required
Array<object>
object
conversions
required
integer format: int64
conversions_micros
required
integer format: int64
event_type
required
string
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
ictr_ppm
required
integer format: int64
impressions
required
integer | null format: int64
keys
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
id
required
integer format: int64
name
required
string
period_end
required
string | null format: date-time
period_start
required
string | null format: date-time
value
required
string
pending_revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
profit
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
revenue
required
object
converted
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
original
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
unconverted
required
boolean
roi_ppm
required
integer format: int64
unique_visits
required
integer format: int64
visits
required
integer format: int64
status
required
string | null
Allowed values: dry_run pending done failed undone warned held
target
required
object
campaign
required
Any of:
object
id
required
integer format: int64
name
string
connection
required
Any of:
object
id
required
integer format: int64
name
string
flow
required
Any of:
object
id
required
integer format: int64
name
string
key
required
Array<string>
level
required
string | null
Allowed values: campaign ad_group ad placement
path
required
Any of:
object
id
required
integer format: int64
name
string
placement
required
string
source_campaign
required
string
undo_change_id
required
string
undo_error_code
required
string
undo_error_message
required
string
undone_at
required
string | null format: date-time
undone_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
updated_at
required
string format: date-time
value_after
required
Any of:
object
amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
factor_ppm
required
integer | null format: int64
value_before
required
Any of:
object
amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
factor_ppm
required
integer | null format: int64
workspace_id
required
integer format: int64

Example 

{
  "block_state": "blocking",
  "kind": "block_placement",
  "source_state": "active",
  "stats": {
    "by_model": [
      {
        "model": "last_click"
      }
    ],
    "changes": [
      {
        "measure": "visits"
      }
    ],
    "keys": [
      {
        "dimension": "hour"
      }
    ]
  },
  "status": "dry_run",
  "target": {
    "level": "campaign"
  },
  "undone_by": {
    "kind": "user"
  }
}

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"
  }
}