Skip to content
Tallyraydocs

Name a bucket for exports, S3 (s3) or Cloud Storage (gcs): your workspace's owner. Nothing goes to it until its secret is set and a test write passes, 10 a workspace

POST
/v1/buyer/destinations
curl --request POST \
  --url https://example.com/v1/buyer/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_sequence": 1, "gcs": { "bucket": "example", "prefix": "example" }, "name": "example", "s3": { "access_key_id": "example", "bucket": "example", "prefix": "example", "region": "example" }, "uncompressed": true }'

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

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
expected_sequence
integer format: int64
gcs
Any of:
object
bucket
string | null
prefix
string | null
name
string | null
s3
Any of:
object
access_key_id
string | null
bucket
string | null
prefix
string | null
region
string | null
uncompressed
boolean | null

Example generated

{
  "expected_sequence": 1,
  "gcs": {
    "bucket": "example",
    "prefix": "example"
  },
  "name": "example",
  "s3": {
    "access_key_id": "example",
    "bucket": "example",
    "prefix": "example",
    "region": "example"
  },
  "uncompressed": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
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
gcs
required
Any of:
object
bucket
required
string
client_email
required
string
prefix
required
string
id
required
integer format: int64
kind
required
string | null
Allowed values: s3 gcs
name
required
string
ready
required
boolean
s3
required
Any of:
object
access_key_id
required
string
bucket
required
string
prefix
required
string
region
required
string
schedules
required
integer format: int32
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
test_error
required
string
tested_at
required
string | null format: date-time
uncompressed
required
boolean
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": "s3",
  "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"
  }
}