Skip to content

Make a lander

POST
/v1/buyer/landers
curl --request POST \
--url https://example.com/v1/buyer/landers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "direct": true, "expected_sequence": 1, "name": "example", "offers_count": 1, "protection": { "enabled": true, "window_seconds": 1 }, "status": "active", "tags": [ "example" ], "url": "example", "validate_only": true }'

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

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

Media typeapplication/json
object
direct
boolean | null
expected_sequence
integer | null format: int64
name
string | null
offers_count
integer | null format: int32
protection
Any of:
object
enabled
required
boolean | null
window_seconds
integer | null format: int64
status
string | null
Allowed values: active paused archived
tags
Array<string> | null
url
string | null
validate_only
boolean

Created

Media typeapplication/json
object
created_at
required
string format: date-time
direct
required
boolean
id
required
integer format: int64
name
required
string
offers_count
required
integer format: int32
origin
required
string
page_id
required
integer format: int64
protection
required
object
enabled
required
boolean
window_seconds
required
integer format: int64
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
workspace_id
required
integer format: int64

Example

{
"status": "active"
}

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