Skip to content

Publish Landing Page

POST
/landing-pages/{landing_page_id}/publish

Deploy the page to a PUBLIC URL. Real people can reach it immediately.

Spends no credit, but it is the outward-facing operation on this router and is tiered and gated accordingly - CAMPAIGNS_LAUNCH, the same permission the app requires, re-declared on this route because the app’s own Depends gate does not run on a direct call.

Omit the body to publish at the page’s own slug on the org’s default domain. override: true takes a URL that is already bound to a DIFFERENT page, and that page stops serving at it.

Spends nothing.

Authorizations

Parameters

Path Parameters

landing_page_id
required

Landing page id.

string

Landing page id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Any of:

Where to publish. Every field optional - omit for the page’s own slug.

override true takes a URL that is already bound to a DIFFERENT page. That page stops serving at it. Left false, a collision is refused.

object
domain
Any of:
string
domain_id
Any of:
integer
override

Steal a URL already bound to another page. Default false.

boolean
path
Any of:
string
slug
Any of:
string
subdomain
Any of:
string

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string