Skip to content
Tallyraydocs

Make a page, a draft: its name, slug, an active custom domain of the workspace's, its target (none for hosted) and its content

POST
/v1/buyer/pages
curl --request POST \
  --url https://example.com/v1/buyer/pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "campaign_key": "example", "content": { "blocks": [ { "align": "start", "button": { "full_width": true, "label": "example", "offer": 1, "style": "filled" }, "divider": {}, "heading": { "level": 1, "text": "example" }, "image": { "alt": "example", "asset_id": 1, "offer": 1, "width": 1 }, "list": { "items": [ "example" ], "style": "bullets" }, "quote": { "author": "example", "text": "example" }, "spacer": { "height": 1 }, "text": { "text": "example" } } ], "description": "example", "favicon_asset_id": 1, "indexable": true, "language": "example", "theme": { "accent_color": "example", "accent_text_color": "example", "background_color": "example", "font": "sans", "max_width": 1, "text_color": "example" }, "title": "example" }, "direct": true, "domain": "example", "expected_sequence": 1, "name": "example", "protected": true, "protection_window_seconds": 1, "slug": "example", "target_id": 1 }'

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
campaign_key
string | null
content
Any of:
object
blocks
required
Array<object>
object
align
string
Allowed values: start center end
button
Any of:
object
full_width
boolean
label
required
string
offer
required
integer format: int32
style
string
Allowed values: filled outlined
divider
Any of:
object
heading
Any of:
object
level
required
integer format: int32
text
required
string
image
Any of:
object
alt
required
string
asset_id
required
integer format: int64
offer
required
integer format: int32
width
required
integer format: int32
list
Any of:
object
items
required
Array<string>
style
string
Allowed values: bullets checks numbers
quote
Any of:
object
author
required
string
text
required
string
spacer
Any of:
object
height
required
integer format: int32
text
Any of:
object
text
required
string
description
string
favicon_asset_id
integer format: int64
indexable
boolean
language
string
theme
Any of:
object
accent_color
string
accent_text_color
string
background_color
string
font
string
Allowed values: sans serif mono rounded
max_width
integer format: int32
text_color
string
title
required
string
direct
boolean | null
domain
string | null
expected_sequence
integer | null format: int64
name
string | null
protected
boolean | null
protection_window_seconds
integer | null format: int64
slug
string | null
target_id
integer | null format: int64

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
campaign_key
required
string
changed
required
boolean
content
required
Any of:
object
blocks
required
Array<object>
object
align
required
string | null
Allowed values: start center end
button
required
Any of:
object
full_width
required
boolean
label
required
string
offer
required
integer format: int32
style
required
string | null
Allowed values: filled outlined
divider
required
Any of:
object
heading
required
Any of:
object
level
required
integer format: int32
text
required
string
image
required
Any of:
object
alt
required
string
asset_id
required
integer format: int64
offer
required
integer format: int32
width
required
integer format: int32
list
required
Any of:
object
items
required
Array<string>
style
required
string | null
Allowed values: bullets checks numbers
quote
required
Any of:
object
author
required
string
text
required
string
spacer
required
Any of:
object
height
required
integer format: int32
text
required
Any of:
object
text
required
string
description
required
string
favicon_asset_id
required
integer format: int64
indexable
required
boolean
language
required
string
theme
required
object
accent_color
required
string
accent_text_color
required
string
background_color
required
string
font
required
string | null
Allowed values: sans serif mono rounded
max_width
required
integer format: int32
text_color
required
string
title
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
direct
required
boolean
domain
required
string
id
required
integer format: int64
latest_build_id
required
string | null
latest_build_number
required
integer format: int32
name
required
string
offers_count
required
integer format: int32
protected
required
boolean
protection_window_seconds
required
integer format: int64
release
required
Any of:
object
build_id
required
string
build_number
required
integer format: int32
deployment_id
required
string
direct
required
boolean
domain
required
string
offers_count
required
integer format: int32
protected
required
boolean
protection_window_seconds
required
integer format: int64
published_at
required
string format: date-time
sequence
required
integer format: int64
status
required
string | null
Allowed values: live archived
target_id
required
integer | null format: int64
target_kind
required
string | null
Allowed values: hosted aws gcp vps
url
required
string
sequence
required
integer format: int64
slug
required
string
status
required
string | null
Allowed values: draft published archived
target_id
required
integer | null format: int64
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 

{
  "content": {
    "blocks": [
      {
        "align": "start",
        "button": {
          "style": "filled"
        },
        "list": {
          "style": "bullets"
        }
      }
    ],
    "theme": {
      "font": "sans"
    }
  },
  "created_by": {
    "kind": "user"
  },
  "release": {
    "status": "live",
    "target_kind": "hosted"
  },
  "status": "draft",
  "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"
  }
}