Skip to content
Tallyraydocs

Change a target, or archive it once no page deploys to it: your workspace's owner

PATCH
/v1/buyer/page-targets/{id}
curl --request PATCH \
  --url https://example.com/v1/buyer/page-targets/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "aws": { "access_key_id": "example", "base_url": "example", "bucket": "example", "distribution_id": "example", "prefix": "example", "region": "example" }, "name": "example", "status": "active" }'

Who: a workspace’s owner. Not for API keys.

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
aws
Any of:
object
access_key_id
string | null
base_url
string | null
bucket
string | null
distribution_id
string | null
prefix
string | null
region
string | null
name
string | null
status
string | null
Allowed values: active archived

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
aws
required
Any of:
object
access_key_id
required
string
base_url
required
string
bucket
required
string
distribution_id
required
string
prefix
required
string
region
required
string
created_at
required
string format: date-time
created_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
id
required
integer format: int64
kind
required
string | null
Allowed values: hosted aws gcp vps
name
required
string
ready
required
boolean
sealed
required
Array<object>
object
last4
required
string
name
required
string
set
required
boolean
updated_at
required
string | null format: date-time
sequence
required
integer format: int64
status
required
string | null
Allowed values: active archived
test_error
required
string
tested_at
required
string | null format: date-time
updated_at
required
string format: date-time
updated_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
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "kind": "hosted",
  "status": "active",
  "updated_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"
  }
}