Skip to content
Tallyraydocs

Pause up to 100 of a connection's source objects at one level at their source: connectors reads each first, pauses only what runs, and records the change

POST
/v1/buyer/source-objects/pause
curl --request POST \
  --url https://example.com/v1/buyer/source-objects/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "connection_id": 1, "keys": [ { "country": "example", "source_campaign": "example", "values": [ "example" ] } ], "level": "campaign", "note": "example" }'

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
connection_id
required
integer format: int64
keys
required
Array<object>
object
country
string
source_campaign
string
values
required
Array<string>
level
required
string
Allowed values: campaign ad_group ad placement
note
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
attempts
required
integer format: int32
changed_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
connection
required
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
done_at
required
string | null format: date-time
error_code
required
string
error_message
required
string
id
required
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
kind
required
string | null
Allowed values: pause resume set_bid set_budget
last_call_id
required
string
level
required
string | null
Allowed values: campaign ad_group ad placement
note
required
string
rule
required
Any of:
object
id
required
integer format: int64
name
string
rules_may_change
required
boolean
schedule
required
Any of:
object
id
required
integer format: int64
name
string
state_after
required
string | null
Allowed values: active paused removed other not_found
state_before
required
string | null
Allowed values: active paused removed other not_found
status
required
string | null
Allowed values: pending done already held refused failed expired
took_over
required
string
undo_of
required
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_asked
required
Any of:
object
ceiling
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
floor
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
from
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
ratio_ppm
required
integer | null format: int64
reset
required
boolean
value
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 

{
  "data": [
    {
      "changed_by": {
        "kind": "user"
      },
      "kind": "pause",
      "level": "campaign",
      "state_after": "active",
      "state_before": "active",
      "status": "pending"
    }
  ]
}

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