Skip to content
Tallyraydocs

Deploy one of a page's builds, its latest unless build_id says: hosted, live at once; to a target, by pages' deployer. An earlier build is a rollback

POST
/v1/buyer/pages/{id}/deploy
curl --request POST \
  --url https://example.com/v1/buyer/pages/example/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "build_id": "example" }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

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
build_id
string

Example generated

{
  "build_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
deployment
required
object
attempts
required
integer format: int32
build_id
required
string
build_number
required
integer format: int32
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
error_code
required
string
error_message
required
string
finished_at
required
string | null format: date-time
id
required
string
next_attempt_at
required
string | null format: date-time
page_id
required
integer format: int64
rollback
required
boolean
started_at
required
string | null format: date-time
status
required
string | null
Allowed values: pending running succeeded failed
target_id
required
integer | null format: int64
target_kind
required
string | null
Allowed values: hosted aws gcp vps
url
required
string
workspace_id
required
integer format: int64
page
required
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 

{
  "deployment": {
    "created_by": {
      "kind": "user"
    },
    "status": "pending",
    "target_kind": "hosted"
  },
  "page": {
    "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"
  }
}